blob: ba7db85094ed68d0eb44906b59d36c892bc2964c [file] [log] [blame]
Nick Lewyckyd489edf2012-02-25 07:20:06 +00001//===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner2f7c9632001-06-06 20:29:01 +00009//
Chris Lattner3e6e3e62002-03-29 19:06:18 +000010// This file defines the function verifier interface, that can be used for some
Chris Lattner2f7c9632001-06-06 20:29:01 +000011// sanity checking of input to the system.
12//
Misha Brukman1c9de462004-06-24 21:47:35 +000013// Note that this does not provide full `Java style' security and verifications,
14// instead it just tries to ensure that code is well-formed.
Chris Lattner2f7c9632001-06-06 20:29:01 +000015//
Misha Brukman1c9de462004-06-24 21:47:35 +000016// * Both of a binary operator's parameters are of the same type
Chris Lattnerd46bb6e2002-04-24 19:12:21 +000017// * Verify that the indices of mem access instructions match other operands
Misha Brukman1c9de462004-06-24 21:47:35 +000018// * Verify that arithmetic and other things are only performed on first-class
Chris Lattner8e72d6f2002-08-02 17:37:08 +000019// types. Verify that shifts & logicals only happen on integrals f.e.
Misha Brukman1c9de462004-06-24 21:47:35 +000020// * All of the constants in a switch statement are of the correct type
Chris Lattner8e72d6f2002-08-02 17:37:08 +000021// * The code is in valid SSA form
Misha Brukman1c9de462004-06-24 21:47:35 +000022// * It should be illegal to put a label into any other type (like a structure)
Chris Lattner2f7c9632001-06-06 20:29:01 +000023// or to return one. [except constant arrays!]
Nick Lewyckyf88c84f2008-03-28 06:46:51 +000024// * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
Chris Lattnerd02f08d2002-02-20 17:55:43 +000025// * PHI nodes must have an entry for each predecessor, with no extras.
Chris Lattner069a7952002-06-25 15:56:27 +000026// * PHI nodes must be the first thing in a basic block, all grouped together
Chris Lattner4cd9df82002-10-06 21:00:31 +000027// * PHI nodes must have at least one entry
Chris Lattner069a7952002-06-25 15:56:27 +000028// * All basic blocks should only end with terminator insts, not contain them
Chris Lattner3e6e3e62002-03-29 19:06:18 +000029// * The entry node to a function must not have predecessors
Misha Brukmanfa100532003-10-10 17:54:14 +000030// * All Instructions must be embedded into a basic block
Misha Brukman1c9de462004-06-24 21:47:35 +000031// * Functions cannot take a void-typed parameter
Chris Lattneraf95e582002-04-13 22:48:46 +000032// * Verify that a function's argument list agrees with it's declared type.
Chris Lattnerfbf5be52002-03-15 20:25:09 +000033// * It is illegal to specify a name for a void value.
Misha Brukmanfa100532003-10-10 17:54:14 +000034// * It is illegal to have a internal global value with no initializer
Chris Lattner486302a2002-04-12 18:20:49 +000035// * It is illegal to have a ret instruction that returns a value that does not
36// agree with the function return value type.
Chris Lattner338a4622002-05-08 19:49:50 +000037// * Function call argument types match the function prototype
Bill Wendlingfae14752011-08-12 20:24:12 +000038// * A landing pad is defined by a landingpad instruction, and can be jumped to
39// only by the unwind edge of an invoke instruction.
40// * A landingpad instruction must be the first non-PHI instruction in the
41// block.
Vedant Kumar029c3512015-10-21 20:33:31 +000042// * Landingpad instructions must be in a function with a personality function.
Chris Lattnerd46bb6e2002-04-24 19:12:21 +000043// * All other things that are tested by asserts spread about the code...
Chris Lattner2f7c9632001-06-06 20:29:01 +000044//
45//===----------------------------------------------------------------------===//
46
Chandler Carruth5ad5f152014-01-13 09:26:24 +000047#include "llvm/IR/Verifier.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000048#include "llvm/ADT/APFloat.h"
49#include "llvm/ADT/APInt.h"
50#include "llvm/ADT/ArrayRef.h"
51#include "llvm/ADT/DenseMap.h"
52#include "llvm/ADT/ilist.h"
Joseph Tremoulet8ea80862016-01-10 04:31:05 +000053#include "llvm/ADT/MapVector.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000054#include "llvm/ADT/Optional.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000055#include "llvm/ADT/STLExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000056#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000057#include "llvm/ADT/SmallSet.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000058#include "llvm/ADT/SmallVector.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000059#include "llvm/ADT/StringMap.h"
60#include "llvm/ADT/StringRef.h"
61#include "llvm/ADT/Twine.h"
62#include "llvm/IR/Argument.h"
63#include "llvm/IR/Attributes.h"
64#include "llvm/IR/BasicBlock.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000065#include "llvm/IR/CFG.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000066#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000067#include "llvm/IR/CallingConv.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000068#include "llvm/IR/Comdat.h"
69#include "llvm/IR/Constant.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000070#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000071#include "llvm/IR/Constants.h"
Matt Arsenault24b49c42013-07-31 17:49:08 +000072#include "llvm/IR/DataLayout.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000073#include "llvm/IR/DebugInfo.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000074#include "llvm/IR/DebugInfoMetadata.h"
75#include "llvm/IR/DebugLoc.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000076#include "llvm/IR/DerivedTypes.h"
Adrian Prantle3656182016-05-09 19:57:29 +000077#include "llvm/IR/DiagnosticInfo.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000078#include "llvm/IR/Dominators.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000079#include "llvm/IR/Function.h"
80#include "llvm/IR/GlobalAlias.h"
81#include "llvm/IR/GlobalValue.h"
82#include "llvm/IR/GlobalVariable.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000083#include "llvm/IR/InlineAsm.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000084#include "llvm/IR/InstrTypes.h"
85#include "llvm/IR/Instruction.h"
86#include "llvm/IR/Instructions.h"
Chandler Carruth7da14f12014-03-06 03:23:41 +000087#include "llvm/IR/InstVisitor.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000088#include "llvm/IR/IntrinsicInst.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000089#include "llvm/IR/Intrinsics.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000090#include "llvm/IR/LLVMContext.h"
91#include "llvm/IR/Metadata.h"
92#include "llvm/IR/Module.h"
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +000093#include "llvm/IR/ModuleSlotTracker.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000094#include "llvm/IR/PassManager.h"
Philip Reames38303a32014-12-03 19:53:15 +000095#include "llvm/IR/Statepoint.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000096#include "llvm/IR/Type.h"
97#include "llvm/IR/Use.h"
98#include "llvm/IR/User.h"
99#include "llvm/IR/Value.h"
Chris Lattner8a923e72008-03-12 17:45:29 +0000100#include "llvm/Pass.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000101#include "llvm/Support/AtomicOrdering.h"
102#include "llvm/Support/Casting.h"
Manman Ren74c61b92013-07-19 00:31:03 +0000103#include "llvm/Support/CommandLine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +0000104#include "llvm/Support/Debug.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000105#include "llvm/Support/Dwarf.h"
Torok Edwin6dd27302009-07-08 18:01:40 +0000106#include "llvm/Support/ErrorHandling.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000107#include "llvm/Support/MathExtras.h"
Chris Lattner24025262009-02-28 21:05:51 +0000108#include "llvm/Support/raw_ostream.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000109#include <algorithm>
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000110#include <cassert>
111#include <cstdint>
112#include <memory>
113#include <string>
114#include <utility>
115
Chris Lattner189d19f2003-11-21 20:23:48 +0000116using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +0000117
Duncan P. N. Exon Smith0633fd72015-03-17 17:28:41 +0000118static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
Manman Ren74c61b92013-07-19 00:31:03 +0000119
Dan Gohmand78c4002008-05-13 00:00:25 +0000120namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000121
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000122struct VerifierSupport {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000123 raw_ostream *OS;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000124 const Module &M;
125 ModuleSlotTracker MST;
126 const DataLayout &DL;
127 LLVMContext &Context;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000128
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +0000129 /// Track the brokenness of the module while recursively visiting.
130 bool Broken = false;
Adrian Prantl541a9c52016-05-06 19:26:47 +0000131 /// Broken debug info can be "recovered" from by stripping the debug info.
132 bool BrokenDebugInfo = false;
133 /// Whether to treat broken debug info as an error.
134 bool TreatBrokenDebugInfoAsError = true;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000135
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000136 explicit VerifierSupport(raw_ostream *OS, const Module &M)
137 : OS(OS), M(M), MST(&M), DL(M.getDataLayout()), Context(M.getContext()) {}
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000138
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000139private:
Keno Fischera6c4ce42015-12-01 19:06:36 +0000140 void Write(const Module *M) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000141 *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
Keno Fischera6c4ce42015-12-01 19:06:36 +0000142 }
143
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000144 void Write(const Value *V) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000145 if (!V)
146 return;
147 if (isa<Instruction>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000148 V->print(*OS, MST);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000149 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000150 } else {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000151 V->printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000152 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000153 }
154 }
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000155
Philip Reames9818dd72015-06-26 22:04:34 +0000156 void Write(ImmutableCallSite CS) {
157 Write(CS.getInstruction());
Philip Reamesa3c6f002015-06-26 21:39:44 +0000158 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000159
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000160 void Write(const Metadata *MD) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000161 if (!MD)
162 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000163 MD->print(*OS, MST, &M);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000164 *OS << '\n';
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000165 }
166
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +0000167 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
168 Write(MD.get());
169 }
170
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000171 void Write(const NamedMDNode *NMD) {
172 if (!NMD)
173 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000174 NMD->print(*OS, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000175 *OS << '\n';
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000176 }
177
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000178 void Write(Type *T) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000179 if (!T)
180 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000181 *OS << ' ' << *T;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000182 }
183
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000184 void Write(const Comdat *C) {
David Majnemerdad0a642014-06-27 18:19:56 +0000185 if (!C)
186 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000187 *OS << *C;
David Majnemerdad0a642014-06-27 18:19:56 +0000188 }
189
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000190 template <typename T> void Write(ArrayRef<T> Vs) {
191 for (const T &V : Vs)
192 Write(V);
193 }
194
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000195 template <typename T1, typename... Ts>
196 void WriteTs(const T1 &V1, const Ts &... Vs) {
197 Write(V1);
198 WriteTs(Vs...);
199 }
200
201 template <typename... Ts> void WriteTs() {}
202
203public:
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000204 /// \brief A check failed, so printout out the condition and the message.
205 ///
206 /// This provides a nice place to put a breakpoint if you want to see why
207 /// something is not correct.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000208 void CheckFailed(const Twine &Message) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000209 if (OS)
210 *OS << Message << '\n';
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +0000211 Broken = true;
David Majnemerdad0a642014-06-27 18:19:56 +0000212 }
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000213
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000214 /// \brief A check failed (with values to print).
215 ///
216 /// This calls the Message-only version so that the above is easier to set a
217 /// breakpoint on.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000218 template <typename T1, typename... Ts>
219 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
220 CheckFailed(Message);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000221 if (OS)
222 WriteTs(V1, Vs...);
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000223 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000224
225 /// A debug info check failed.
226 void DebugInfoCheckFailed(const Twine &Message) {
227 if (OS)
228 *OS << Message << '\n';
229 Broken |= TreatBrokenDebugInfoAsError;
230 BrokenDebugInfo = true;
231 }
232
233 /// A debug info check failed (with values to print).
234 template <typename T1, typename... Ts>
235 void DebugInfoCheckFailed(const Twine &Message, const T1 &V1,
236 const Ts &... Vs) {
237 DebugInfoCheckFailed(Message);
238 if (OS)
239 WriteTs(V1, Vs...);
240 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000241};
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000242
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000243class Verifier : public InstVisitor<Verifier>, VerifierSupport {
244 friend class InstVisitor<Verifier>;
245
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000246 DominatorTree DT;
Chris Lattnerc9e79d02004-09-29 20:07:45 +0000247
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000248 /// \brief When verifying a basic block, keep track of all of the
249 /// instructions we have seen so far.
250 ///
251 /// This allows us to do efficient dominance checks for the case when an
252 /// instruction has an operand that is an instruction in the same block.
253 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
Bill Wendlingfae14752011-08-12 20:24:12 +0000254
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000255 /// \brief Keep track of the metadata nodes that have been checked already.
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000256 SmallPtrSet<const Metadata *, 32> MDNodes;
Manman Ren9974c882013-07-23 00:22:51 +0000257
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000258 /// Track all DICompileUnits visited.
259 SmallPtrSet<const Metadata *, 2> CUVisited;
260
David Majnemer654e1302015-07-31 17:58:14 +0000261 /// \brief The result type for a landingpad.
262 Type *LandingPadResultTy;
263
Reid Kleckner60381792015-07-07 22:25:32 +0000264 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000265 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000266 bool SawFrameEscape;
267
Reid Kleckner60381792015-07-07 22:25:32 +0000268 /// Stores the count of how many objects were passed to llvm.localescape for a
269 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000270 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000271
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000272 // Maps catchswitches and cleanuppads that unwind to siblings to the
273 // terminators that indicate the unwind, used to detect cycles therein.
274 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
275
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000276 /// Cache of constants visited in search of ConstantExprs.
277 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
278
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000279 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
280 SmallVector<const Function *, 4> DeoptimizeDeclarations;
281
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000282 // Verify that this GlobalValue is only used in this module.
283 // This map is used to avoid visiting uses twice. We can arrive at a user
284 // twice, if they have multiple operands. In particular for very large
285 // constant expressions, we can arrive at a particular user many times.
286 SmallPtrSet<const Value *, 32> GlobalValueVisited;
287
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000288 void checkAtomicMemAccessSize(Type *Ty, const Instruction *I);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000289
Chandler Carruth043949d2014-01-19 02:22:18 +0000290public:
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000291 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError,
292 const Module &M)
293 : VerifierSupport(OS, M), LandingPadResultTy(nullptr),
Adrian Prantl541a9c52016-05-06 19:26:47 +0000294 SawFrameEscape(false) {
295 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
296 }
297
298 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
Chris Lattner0e851da2002-04-18 20:37:37 +0000299
Chandler Carruth043949d2014-01-19 02:22:18 +0000300 bool verify(const Function &F) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000301 assert(F.getParent() == &M &&
302 "An instance of this class only works with a specific module!");
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000303
304 // First ensure the function is well-enough formed to compute dominance
Peter Collingbourne71bb7942016-06-06 22:32:52 +0000305 // information, and directly compute a dominance tree. We don't rely on the
306 // pass manager to provide this as it isolates us from a potentially
307 // out-of-date dominator tree and makes it significantly more complex to run
308 // this code outside of a pass manager.
309 // FIXME: It's really gross that we have to cast away constness here.
310 if (!F.empty())
311 DT.recalculate(const_cast<Function &>(F));
312
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000313 for (const BasicBlock &BB : F) {
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000314 if (!BB.empty() && BB.back().isTerminator())
315 continue;
316
317 if (OS) {
318 *OS << "Basic Block in function '" << F.getName()
319 << "' does not have terminator!\n";
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000320 BB.printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000321 *OS << "\n";
Chandler Carruth76777602014-01-17 10:56:02 +0000322 }
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000323 return false;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000324 }
Chandler Carruth76777602014-01-17 10:56:02 +0000325
Chandler Carruth043949d2014-01-19 02:22:18 +0000326 Broken = false;
327 // FIXME: We strip const here because the inst visitor strips const.
328 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000329 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000330 InstsInThisBlock.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000331 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000332 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000333 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000334
Chandler Carruth043949d2014-01-19 02:22:18 +0000335 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000336 }
337
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000338 /// Verify the module that this instance of \c Verifier was initialized with.
339 bool verify() {
Chandler Carruth043949d2014-01-19 02:22:18 +0000340 Broken = false;
341
Peter Collingbournebb738172016-06-06 23:21:27 +0000342 // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
343 for (const Function &F : M)
344 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
345 DeoptimizeDeclarations.push_back(&F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000346
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000347 // Now that we've visited every function, verify that we never asked to
348 // recover a frame index that wasn't escaped.
349 verifyFrameRecoverIndices();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000350 for (const GlobalVariable &GV : M.globals())
351 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000352
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000353 for (const GlobalAlias &GA : M.aliases())
354 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000355
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000356 for (const NamedMDNode &NMD : M.named_metadata())
357 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000358
David Majnemerdad0a642014-06-27 18:19:56 +0000359 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
360 visitComdat(SMEC.getValue());
361
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000362 visitModuleFlags(M);
363 visitModuleIdents(M);
364
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000365 verifyCompileUnits();
366
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000367 verifyDeoptimizeCallingConvs();
368
Chandler Carruth043949d2014-01-19 02:22:18 +0000369 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000370 }
Chris Lattner9713b842002-04-28 16:04:26 +0000371
Chandler Carruth043949d2014-01-19 02:22:18 +0000372private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000373 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000374 void visitGlobalValue(const GlobalValue &GV);
375 void visitGlobalVariable(const GlobalVariable &GV);
376 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000377 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000378 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000379 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000380 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000381 void visitMDNode(const MDNode &MD);
382 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
383 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000384 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000385 void visitModuleIdents(const Module &M);
386 void visitModuleFlags(const Module &M);
387 void visitModuleFlag(const MDNode *Op,
388 DenseMap<const MDString *, const MDNode *> &SeenIDs,
389 SmallVectorImpl<const MDNode *> &Requirements);
390 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000391 void visitBasicBlock(BasicBlock &BB);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000392 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
Artur Pilipenkocca80022015-10-09 17:41:29 +0000393 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000394
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000395 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000396#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
397#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000398 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000399 void visitDIVariable(const DIVariable &N);
400 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
401 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000402
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000403 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
404
Chandler Carruth043949d2014-01-19 02:22:18 +0000405 // InstVisitor overrides...
406 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000407 void visit(Instruction &I);
408
409 void visitTruncInst(TruncInst &I);
410 void visitZExtInst(ZExtInst &I);
411 void visitSExtInst(SExtInst &I);
412 void visitFPTruncInst(FPTruncInst &I);
413 void visitFPExtInst(FPExtInst &I);
414 void visitFPToUIInst(FPToUIInst &I);
415 void visitFPToSIInst(FPToSIInst &I);
416 void visitUIToFPInst(UIToFPInst &I);
417 void visitSIToFPInst(SIToFPInst &I);
418 void visitIntToPtrInst(IntToPtrInst &I);
419 void visitPtrToIntInst(PtrToIntInst &I);
420 void visitBitCastInst(BitCastInst &I);
421 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
422 void visitPHINode(PHINode &PN);
423 void visitBinaryOperator(BinaryOperator &B);
424 void visitICmpInst(ICmpInst &IC);
425 void visitFCmpInst(FCmpInst &FC);
426 void visitExtractElementInst(ExtractElementInst &EI);
427 void visitInsertElementInst(InsertElementInst &EI);
428 void visitShuffleVectorInst(ShuffleVectorInst &EI);
429 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
430 void visitCallInst(CallInst &CI);
431 void visitInvokeInst(InvokeInst &II);
432 void visitGetElementPtrInst(GetElementPtrInst &GEP);
433 void visitLoadInst(LoadInst &LI);
434 void visitStoreInst(StoreInst &SI);
435 void verifyDominatesUse(Instruction &I, unsigned i);
436 void visitInstruction(Instruction &I);
437 void visitTerminatorInst(TerminatorInst &I);
438 void visitBranchInst(BranchInst &BI);
439 void visitReturnInst(ReturnInst &RI);
440 void visitSwitchInst(SwitchInst &SI);
441 void visitIndirectBrInst(IndirectBrInst &BI);
442 void visitSelectInst(SelectInst &SI);
443 void visitUserOp1(Instruction &I);
444 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000445 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000446 template <class DbgIntrinsicTy>
447 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000448 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
449 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
450 void visitFenceInst(FenceInst &FI);
451 void visitAllocaInst(AllocaInst &AI);
452 void visitExtractValueInst(ExtractValueInst &EVI);
453 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000454 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000455 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemerba6665d2016-08-01 18:06:34 +0000456 void visitResumeInst(ResumeInst &RI);
David Majnemer654e1302015-07-31 17:58:14 +0000457 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000458 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000459 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000460 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000461 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000462 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000463
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000464 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000465 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
466 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000467 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000468 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000469 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000470 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
471 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000472 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000473 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000474 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000475 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000476 const Value *V);
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +0000477 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000478
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000479 void visitConstantExprsRecursively(const Constant *EntryC);
480 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000481 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000482 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000483 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000484
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000485 void verifyBitPieceExpression(const DbgInfoIntrinsic &I);
486
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000487 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000488 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000489
490 /// Module-level verification that all @llvm.experimental.deoptimize
491 /// declarations share the same calling convention.
492 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000493};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000494
495} // end anonymous namespace
Chris Lattner189d19f2003-11-21 20:23:48 +0000496
Adrian Prantl541a9c52016-05-06 19:26:47 +0000497/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000498#define Assert(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000499 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (false)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000500
Adrian Prantl541a9c52016-05-06 19:26:47 +0000501/// We know that a debug info condition should be true, if not print
502/// an error message.
503#define AssertDI(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000504 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (false)
Adrian Prantl541a9c52016-05-06 19:26:47 +0000505
Chris Lattnere5a22c02008-08-28 04:02:44 +0000506void Verifier::visit(Instruction &I) {
507 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000508 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000509 InstVisitor<Verifier>::visit(I);
510}
511
Keno Fischer60f82a22016-01-14 22:20:56 +0000512// Helper to recursively iterate over indirect users. By
513// returning false, the callback can ask to stop recursing
514// further.
515static void forEachUser(const Value *User,
516 SmallPtrSet<const Value *, 32> &Visited,
517 llvm::function_ref<bool(const Value *)> Callback) {
518 if (!Visited.insert(User).second)
519 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000520 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000521 if (Callback(TheNextUser))
522 forEachUser(TheNextUser, Visited, Callback);
523}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000524
Chandler Carruth043949d2014-01-19 02:22:18 +0000525void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000526 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000527 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000528
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000529 Assert(GV.getAlignment() <= Value::MaximumAlignment,
530 "huge alignment values are unsupported", &GV);
531 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
532 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000533
534 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000535 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000536 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000537 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000538 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000539
540 if (GV.isDeclarationForLinker())
541 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000542
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000543 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000544 if (const Instruction *I = dyn_cast<Instruction>(V)) {
545 if (!I->getParent() || !I->getParent()->getParent())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000546 CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
547 I);
548 else if (I->getParent()->getParent()->getParent() != &M)
549 CheckFailed("Global is referenced in a different module!", &GV, &M, I,
550 I->getParent()->getParent(),
Keno Fischer60f82a22016-01-14 22:20:56 +0000551 I->getParent()->getParent()->getParent());
552 return false;
553 } else if (const Function *F = dyn_cast<Function>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000554 if (F->getParent() != &M)
555 CheckFailed("Global is used by function in a different module", &GV, &M,
556 F, F->getParent());
Keno Fischer60f82a22016-01-14 22:20:56 +0000557 return false;
558 }
559 return true;
560 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000561}
562
Chandler Carruth043949d2014-01-19 02:22:18 +0000563void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000564 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000565 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000566 "Global variable initializer type does not match global "
567 "variable type!",
568 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000569
Chris Lattner0aff0b22009-08-05 05:41:44 +0000570 // If the global has common linkage, it must have a zero initializer and
571 // cannot be constant.
572 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000573 Assert(GV.getInitializer()->isNullValue(),
574 "'common' global must have a zero initializer!", &GV);
575 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
576 &GV);
577 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000578 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000579 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000580
Nick Lewycky466d0c12011-04-08 07:30:21 +0000581 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
582 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000583 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
584 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000585 // Don't worry about emitting an error for it not being an array,
586 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000587 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000588 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
589 PointerType *FuncPtrTy =
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000590 FunctionType::get(Type::getVoidTy(Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000591 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000592 Assert(STy &&
593 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
594 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
595 STy->getTypeAtIndex(1) == FuncPtrTy,
596 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000597 if (STy->getNumElements() == 3) {
598 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000599 Assert(ETy->isPointerTy() &&
600 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
601 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000602 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000603 }
604 }
605
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000606 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000607 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000608 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
609 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000610 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000611 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
612 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000613 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000614 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000615 const Constant *Init = GV.getInitializer();
616 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000617 Assert(InitArray, "wrong initalizer for intrinsic global variable",
618 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000619 for (Value *Op : InitArray->operands()) {
620 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000621 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
622 isa<GlobalAlias>(V),
623 "invalid llvm.used member", V);
624 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000625 }
626 }
627 }
628 }
629
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000630 Assert(!GV.hasDLLImportStorageClass() ||
631 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
632 GV.hasAvailableExternallyLinkage(),
633 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000634
Matt Arsenault24b49c42013-07-31 17:49:08 +0000635 if (!GV.hasInitializer()) {
636 visitGlobalValue(GV);
637 return;
638 }
639
640 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000641 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000642
Chris Lattnere3400652004-12-15 20:23:49 +0000643 visitGlobalValue(GV);
644}
645
Rafael Espindola64c1e182014-06-03 02:41:57 +0000646void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
647 SmallPtrSet<const GlobalAlias*, 4> Visited;
648 Visited.insert(&GA);
649 visitAliaseeSubExpr(Visited, GA, C);
650}
651
Craig Topper71b7b682014-08-21 05:55:13 +0000652void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000653 const GlobalAlias &GA, const Constant &C) {
654 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000655 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
656 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000657
658 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000659 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000660
Sanjoy Das5ce32722016-04-08 00:48:30 +0000661 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000662 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000663 } else {
664 // Only continue verifying subexpressions of GlobalAliases.
665 // Do not recurse into global initializers.
666 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000667 }
668 }
669
670 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000671 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000672
673 for (const Use &U : C.operands()) {
674 Value *V = &*U;
675 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
676 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
677 else if (const auto *C2 = dyn_cast<Constant>(V))
678 visitAliaseeSubExpr(Visited, GA, *C2);
679 }
680}
681
Chandler Carruth043949d2014-01-19 02:22:18 +0000682void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000683 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
684 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
685 "weak_odr, or external linkage!",
686 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000687 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000688 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
689 Assert(GA.getType() == Aliasee->getType(),
690 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000691
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000692 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
693 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000694
Rafael Espindola64c1e182014-06-03 02:41:57 +0000695 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000696
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000697 visitGlobalValue(GA);
698}
699
Chandler Carruth043949d2014-01-19 02:22:18 +0000700void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000701 for (const MDNode *MD : NMD.operands()) {
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000702 if (NMD.getName() == "llvm.dbg.cu") {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000703 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000704 }
705
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000706 if (!MD)
707 continue;
708
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000709 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000710 }
711}
712
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000713void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000714 // Only visit each node once. Metadata can be mutually recursive, so this
715 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000716 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000717 return;
718
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000719 switch (MD.getMetadataID()) {
720 default:
721 llvm_unreachable("Invalid MDNode subclass");
722 case Metadata::MDTupleKind:
723 break;
724#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
725 case Metadata::CLASS##Kind: \
726 visit##CLASS(cast<CLASS>(MD)); \
727 break;
728#include "llvm/IR/Metadata.def"
729 }
730
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000731 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000732 if (!Op)
733 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000734 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
735 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000736 if (auto *N = dyn_cast<MDNode>(Op)) {
737 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000738 continue;
739 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000740 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
741 visitValueAsMetadata(*V, nullptr);
742 continue;
743 }
Duncan Sands76d62172010-04-29 16:10:30 +0000744 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000745
746 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000747 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
748 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000749}
750
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000751void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000752 Assert(MD.getValue(), "Expected valid value", &MD);
753 Assert(!MD.getValue()->getType()->isMetadataTy(),
754 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000755
756 auto *L = dyn_cast<LocalAsMetadata>(&MD);
757 if (!L)
758 return;
759
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000760 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000761
762 // If this was an instruction, bb, or argument, verify that it is in the
763 // function that we expect.
764 Function *ActualF = nullptr;
765 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000766 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000767 ActualF = I->getParent()->getParent();
768 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
769 ActualF = BB->getParent();
770 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
771 ActualF = A->getParent();
772 assert(ActualF && "Unimplemented function local metadata case!");
773
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000774 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000775}
776
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000777void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000778 Metadata *MD = MDV.getMetadata();
779 if (auto *N = dyn_cast<MDNode>(MD)) {
780 visitMDNode(*N);
781 return;
782 }
783
784 // Only visit each node once. Metadata can be mutually recursive, so this
785 // avoids infinite recursion here, as well as being an optimization.
786 if (!MDNodes.insert(MD).second)
787 return;
788
789 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
790 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000791}
792
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000793static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
794static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
795static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000796
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000797template <class Ty>
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000798static bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000799 for (Metadata *MD : N.operands()) {
800 if (MD) {
801 if (!isa<Ty>(MD))
802 return false;
803 } else {
804 if (!AllowNull)
805 return false;
806 }
807 }
808 return true;
809}
810
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000811template <class Ty> static bool isValidMetadataArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000812 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
813}
814
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000815template <class Ty> static bool isValidMetadataNullArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000816 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
817}
818
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000819void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000820 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
821 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000822 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000823 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000824}
825
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000826void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000827 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000828}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000829
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000830void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000831 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000832 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000833}
834
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000835void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000836 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
837 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000838}
839
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000840void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000841 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000842}
843
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000844void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000845 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
846 N.getTag() == dwarf::DW_TAG_unspecified_type,
847 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000848}
849
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000850void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000851 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000852 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000853
Adrian Prantl541a9c52016-05-06 19:26:47 +0000854 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
855 N.getTag() == dwarf::DW_TAG_pointer_type ||
856 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
857 N.getTag() == dwarf::DW_TAG_reference_type ||
858 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
859 N.getTag() == dwarf::DW_TAG_const_type ||
860 N.getTag() == dwarf::DW_TAG_volatile_type ||
861 N.getTag() == dwarf::DW_TAG_restrict_type ||
862 N.getTag() == dwarf::DW_TAG_member ||
863 N.getTag() == dwarf::DW_TAG_inheritance ||
864 N.getTag() == dwarf::DW_TAG_friend,
865 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000866 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000867 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
868 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000869 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000870
Adrian Prantl541a9c52016-05-06 19:26:47 +0000871 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
872 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
873 N.getRawBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000874}
875
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000876static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000877 return (Flags & DINode::FlagLValueReference) &&
878 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000879}
880
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000881void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
882 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000883 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000884 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000885 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
886 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000887 }
888}
889
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000890void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000891 // Common scope checks.
892 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000893
Adrian Prantl541a9c52016-05-06 19:26:47 +0000894 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
895 N.getTag() == dwarf::DW_TAG_structure_type ||
896 N.getTag() == dwarf::DW_TAG_union_type ||
897 N.getTag() == dwarf::DW_TAG_enumeration_type ||
898 N.getTag() == dwarf::DW_TAG_class_type,
899 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000900
Adrian Prantl541a9c52016-05-06 19:26:47 +0000901 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
902 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
903 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000904
Adrian Prantl541a9c52016-05-06 19:26:47 +0000905 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
906 "invalid composite elements", &N, N.getRawElements());
907 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
908 N.getRawVTableHolder());
909 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
910 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000911 if (auto *Params = N.getRawTemplateParams())
912 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000913
914 if (N.getTag() == dwarf::DW_TAG_class_type ||
915 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000916 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
917 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000918 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000919}
920
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000921void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000922 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000923 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000924 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000925 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000926 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000927 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000928 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000929 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
930 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000931}
932
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000933void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000934 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000935}
936
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000937void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000938 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
939 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000940
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000941 // Don't bother verifying the compilation directory or producer string
942 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000943 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
944 N.getRawFile());
945 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
946 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000947
Adrian Prantl541a9c52016-05-06 19:26:47 +0000948 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
949 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000950
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000951 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000952 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000953 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000954 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000955 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
956 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000957 }
958 }
959 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000960 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000961 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000962 AssertDI(Op && (isa<DIType>(Op) ||
963 (isa<DISubprogram>(Op) &&
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000964 !cast<DISubprogram>(Op)->isDefinition())),
Adrian Prantl541a9c52016-05-06 19:26:47 +0000965 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000966 }
967 }
968 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000969 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000970 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000971 AssertDI(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref",
972 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000973 }
974 }
975 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000976 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000977 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000978 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
979 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000980 }
981 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000982 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000983 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000984 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000985 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000986 }
987 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000988 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000989}
990
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000991void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000992 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
993 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +0000994 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000995 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000996 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000997 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
998 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
999 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001000 if (auto *Params = N.getRawTemplateParams())
1001 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001002 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001003 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1004 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001005 if (auto *RawVars = N.getRawVariables()) {
1006 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001007 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001008 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001009 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
1010 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001011 }
1012 }
Adrian Prantl541a9c52016-05-06 19:26:47 +00001013 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1014 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001015
Adrian Prantl75819ae2016-04-15 15:57:41 +00001016 auto *Unit = N.getRawUnit();
1017 if (N.isDefinition()) {
1018 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001019 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1020 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1021 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001022 } else {
1023 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001024 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001025 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001026}
1027
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001028void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001029 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1030 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1031 "invalid local scope", &N, N.getRawScope());
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001032}
1033
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001034void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1035 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001036
Adrian Prantl541a9c52016-05-06 19:26:47 +00001037 AssertDI(N.getLine() || !N.getColumn(),
1038 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001039}
1040
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001041void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1042 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001043}
1044
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001045void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001046 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001047 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001048 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001049}
1050
Amjad Abouda9bcf162015-12-10 12:56:35 +00001051void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001052 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1053 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1054 "invalid macinfo type", &N);
1055 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001056 if (!N.getValue().empty()) {
1057 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1058 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001059}
1060
1061void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001062 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1063 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001064 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001065 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001066
1067 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001068 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001069 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001070 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001071 }
1072 }
1073}
1074
Adrian Prantlab1243f2015-06-29 23:03:47 +00001075void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001076 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1077 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001078}
1079
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001080void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001081 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001082}
1083
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001084void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1085 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001086
Adrian Prantl541a9c52016-05-06 19:26:47 +00001087 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1088 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001089}
1090
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001091void Verifier::visitDITemplateValueParameter(
1092 const DITemplateValueParameter &N) {
1093 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001094
Adrian Prantl541a9c52016-05-06 19:26:47 +00001095 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1096 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1097 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1098 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001099}
1100
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001101void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001102 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001103 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1104 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001105 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001106 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001107}
1108
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001109void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001110 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001111 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001112
Adrian Prantl541a9c52016-05-06 19:26:47 +00001113 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1114 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001115 if (auto *V = N.getRawVariable()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001116 AssertDI(isa<ConstantAsMetadata>(V) &&
1117 !isa<Function>(cast<ConstantAsMetadata>(V)->getValue()),
Nico Weber0c285572016-08-24 16:34:54 +00001118 "invalid global variable ref", &N, V);
Keno Fischerf6d17b92016-01-14 22:42:02 +00001119 visitConstantExprsRecursively(cast<ConstantAsMetadata>(V)->getValue());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001120 }
1121 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001122 AssertDI(isa<DIDerivedType>(Member),
1123 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001124 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001125}
1126
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001127void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001128 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001129 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001130
Adrian Prantl541a9c52016-05-06 19:26:47 +00001131 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1132 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1133 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001134}
1135
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001136void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001137 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001138}
1139
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001140void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001141 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001142 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001143 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001144 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001145 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001146}
1147
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001148void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001149 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1150 N.getTag() == dwarf::DW_TAG_imported_declaration,
1151 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001152 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001153 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1154 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1155 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001156}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001157
David Majnemerdad0a642014-06-27 18:19:56 +00001158void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001159 // The Module is invalid if the GlobalValue has private linkage. Entities
1160 // with private linkage don't have entries in the symbol table.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001161 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001162 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1163 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001164}
1165
Chandler Carruth043949d2014-01-19 02:22:18 +00001166void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001167 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1168 if (!Idents)
1169 return;
1170
1171 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1172 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001173 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001174 Assert(N->getNumOperands() == 1,
1175 "incorrect number of operands in llvm.ident metadata", N);
1176 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1177 ("invalid value for llvm.ident metadata entry operand"
1178 "(the operand should be a string)"),
1179 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001180 }
1181}
1182
Chandler Carruth043949d2014-01-19 02:22:18 +00001183void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001184 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1185 if (!Flags) return;
1186
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001187 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001188 DenseMap<const MDString*, const MDNode*> SeenIDs;
1189 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001190 for (const MDNode *MDN : Flags->operands())
1191 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001192
1193 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001194 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001195 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001196 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001197
Chandler Carruth043949d2014-01-19 02:22:18 +00001198 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001199 if (!Op) {
1200 CheckFailed("invalid requirement on flag, flag is not present in module",
1201 Flag);
1202 continue;
1203 }
1204
1205 if (Op->getOperand(2) != ReqValue) {
1206 CheckFailed(("invalid requirement on flag, "
1207 "flag does not have the required value"),
1208 Flag);
1209 continue;
1210 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001211 }
1212}
1213
Chandler Carruth043949d2014-01-19 02:22:18 +00001214void
1215Verifier::visitModuleFlag(const MDNode *Op,
1216 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1217 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001218 // Each module flag should have three arguments, the merge behavior (a
1219 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001220 Assert(Op->getNumOperands() == 3,
1221 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001222 Module::ModFlagBehavior MFB;
1223 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001224 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001225 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001226 "invalid behavior operand in module flag (expected constant integer)",
1227 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001228 Assert(false,
1229 "invalid behavior operand in module flag (unexpected constant)",
1230 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001231 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001232 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001233 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1234 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001235
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001236 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001237 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001238 case Module::Error:
1239 case Module::Warning:
1240 case Module::Override:
1241 // These behavior types accept any value.
1242 break;
1243
1244 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001245 // The value should itself be an MDNode with two operands, a flag ID (an
1246 // MDString), and a value.
1247 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001248 Assert(Value && Value->getNumOperands() == 2,
1249 "invalid value for 'require' module flag (expected metadata pair)",
1250 Op->getOperand(2));
1251 Assert(isa<MDString>(Value->getOperand(0)),
1252 ("invalid value for 'require' module flag "
1253 "(first value operand should be a string)"),
1254 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001255
1256 // Append it to the list of requirements, to check once all module flags are
1257 // scanned.
1258 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001259 break;
1260 }
1261
1262 case Module::Append:
1263 case Module::AppendUnique: {
1264 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001265 Assert(isa<MDNode>(Op->getOperand(2)),
1266 "invalid value for 'append'-type module flag "
1267 "(expected a metadata node)",
1268 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001269 break;
1270 }
1271 }
1272
1273 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001274 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001275 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001276 Assert(Inserted,
1277 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001278 }
1279}
1280
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001281void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001282 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001283 unsigned Slot = ~0U;
1284 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1285 if (Attrs.getSlotIndex(I) == Idx) {
1286 Slot = I;
1287 break;
1288 }
1289
1290 assert(Slot != ~0U && "Attribute set inconsistency!");
1291
1292 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1293 I != E; ++I) {
1294 if (I->isStringAttribute())
1295 continue;
1296
1297 if (I->getKindAsEnum() == Attribute::NoReturn ||
1298 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001299 I->getKindAsEnum() == Attribute::NoInline ||
1300 I->getKindAsEnum() == Attribute::AlwaysInline ||
1301 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1302 I->getKindAsEnum() == Attribute::StackProtect ||
1303 I->getKindAsEnum() == Attribute::StackProtectReq ||
1304 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001305 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001306 I->getKindAsEnum() == Attribute::NoRedZone ||
1307 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1308 I->getKindAsEnum() == Attribute::Naked ||
1309 I->getKindAsEnum() == Attribute::InlineHint ||
1310 I->getKindAsEnum() == Attribute::StackAlignment ||
1311 I->getKindAsEnum() == Attribute::UWTable ||
1312 I->getKindAsEnum() == Attribute::NonLazyBind ||
1313 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1314 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1315 I->getKindAsEnum() == Attribute::SanitizeThread ||
1316 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1317 I->getKindAsEnum() == Attribute::MinSize ||
1318 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001319 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001320 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001321 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001322 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001323 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001324 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001325 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001326 I->getKindAsEnum() == Attribute::NoRecurse ||
1327 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
George Burgess IV278199f2016-04-12 01:05:35 +00001328 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1329 I->getKindAsEnum() == Attribute::AllocSize) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001330 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001331 CheckFailed("Attribute '" + I->getAsString() +
1332 "' only applies to functions!", V);
1333 return;
1334 }
1335 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001336 I->getKindAsEnum() == Attribute::WriteOnly ||
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001337 I->getKindAsEnum() == Attribute::ReadNone) {
1338 if (Idx == 0) {
1339 CheckFailed("Attribute '" + I->getAsString() +
1340 "' does not apply to function returns");
1341 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001342 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001343 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001344 CheckFailed("Attribute '" + I->getAsString() +
1345 "' does not apply to functions!", V);
1346 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001347 }
1348 }
1349}
1350
Duncan Sandsc3a79922009-06-11 08:11:03 +00001351// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001352// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001353void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001354 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001355 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001356 return;
1357
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001358 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001359
Bill Wendling908126a2012-10-09 09:51:10 +00001360 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001361 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1362 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1363 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1364 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1365 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001366 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001367 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1368 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001369 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001370 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001371 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001372 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001373
Reid Klecknera534a382013-12-19 02:14:12 +00001374 // Check for mutually incompatible attributes. Only inreg is compatible with
1375 // sret.
1376 unsigned AttrCount = 0;
1377 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1378 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1379 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1380 Attrs.hasAttribute(Idx, Attribute::InReg);
1381 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001382 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1383 "and 'sret' are incompatible!",
1384 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001385
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001386 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1387 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1388 "Attributes "
1389 "'inalloca and readonly' are incompatible!",
1390 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001391
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001392 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1393 Attrs.hasAttribute(Idx, Attribute::Returned)),
1394 "Attributes "
1395 "'sret and returned' are incompatible!",
1396 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001397
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001398 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1399 Attrs.hasAttribute(Idx, Attribute::SExt)),
1400 "Attributes "
1401 "'zeroext and signext' are incompatible!",
1402 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001403
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001404 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1405 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1406 "Attributes "
1407 "'readnone and readonly' are incompatible!",
1408 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001409
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001410 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1411 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1412 "Attributes "
1413 "'readnone and writeonly' are incompatible!",
1414 V);
1415
1416 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadOnly) &&
1417 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1418 "Attributes "
1419 "'readonly and writeonly' are incompatible!",
1420 V);
1421
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001422 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1423 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1424 "Attributes "
1425 "'noinline and alwaysinline' are incompatible!",
1426 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001427
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001428 Assert(
1429 !AttrBuilder(Attrs, Idx).overlaps(AttributeFuncs::typeIncompatible(Ty)),
1430 "Wrong types for attribute: " +
1431 AttributeSet::get(Context, Idx, AttributeFuncs::typeIncompatible(Ty))
1432 .getAsString(Idx),
1433 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001434
Reid Klecknera534a382013-12-19 02:14:12 +00001435 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001436 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001437 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001438 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1439 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1440 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1441 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001442 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001443 if (!isa<PointerType>(PTy->getElementType()))
1444 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1445 "Attribute 'swifterror' only applies to parameters "
1446 "with pointer to pointer type!",
1447 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001448 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001449 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1450 "Attribute 'byval' only applies to parameters with pointer type!",
1451 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001452 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1453 "Attribute 'swifterror' only applies to parameters "
1454 "with pointer type!",
1455 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001456 }
Duncan Sands0009c442008-01-12 16:42:01 +00001457}
1458
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001459// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001460// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001461void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001462 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001463 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001464 return;
1465
Duncan Sands8c582282007-12-21 19:19:01 +00001466 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001467 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001468 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001469 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001470 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001471
Chris Lattner8a923e72008-03-12 17:45:29 +00001472 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001473 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001474
Chris Lattner229907c2011-07-18 04:54:35 +00001475 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001476 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001477 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001478 else if (Idx-1 < FT->getNumParams())
1479 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001480 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001481 break; // VarArgs attributes, verified elsewhere.
1482
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001483 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001484
Stephen Linb8bd2322013-04-20 05:14:40 +00001485 if (Idx == 0)
1486 continue;
1487
1488 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001489 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001490 SawNest = true;
1491 }
1492
Stephen Linb8bd2322013-04-20 05:14:40 +00001493 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001494 Assert(!SawReturned, "More than one parameter has attribute returned!",
1495 V);
1496 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1497 "Incompatible "
1498 "argument and return types for 'returned' attribute",
1499 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001500 SawReturned = true;
1501 }
1502
Reid Kleckner79418562014-05-09 22:32:13 +00001503 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001504 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1505 Assert(Idx == 1 || Idx == 2,
1506 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001507 SawSRet = true;
1508 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001509
Manman Renf46262e2016-03-29 17:37:21 +00001510 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1511 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1512 SawSwiftSelf = true;
1513 }
1514
Manman Ren9bfd0d02016-04-01 21:41:15 +00001515 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1516 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1517 V);
1518 SawSwiftError = true;
1519 }
1520
Reid Kleckner60d3a832014-01-16 22:59:24 +00001521 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001522 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1523 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001524 }
Duncan Sands8c582282007-12-21 19:19:01 +00001525 }
Devang Patel9cc98122008-10-01 23:41:25 +00001526
Bill Wendling77543892013-01-18 21:11:39 +00001527 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1528 return;
1529
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001530 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001531
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001532 Assert(
1533 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1534 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1535 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001536
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001537 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001538 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001539 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1540 "Attributes 'readnone and writeonly' are incompatible!", V);
1541
1542 Assert(
1543 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly) &&
1544 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1545 "Attributes 'readonly and writeonly' are incompatible!", V);
1546
1547 Assert(
1548 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001549 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1550 Attribute::InaccessibleMemOrArgMemOnly)),
1551 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1552
1553 Assert(
1554 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1555 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1556 Attribute::InaccessibleMemOnly)),
1557 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1558
1559 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001560 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1561 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1562 Attribute::AlwaysInline)),
1563 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001564
1565 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1566 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001567 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1568 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001569
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001570 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1571 Attribute::OptimizeForSize),
1572 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001573
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001574 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1575 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001576 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001577
1578 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1579 Attribute::JumpTable)) {
1580 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001581 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001582 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001583 }
George Burgess IV278199f2016-04-12 01:05:35 +00001584
1585 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1586 std::pair<unsigned, Optional<unsigned>> Args =
1587 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1588
1589 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1590 if (ParamNo >= FT->getNumParams()) {
1591 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1592 return false;
1593 }
1594
1595 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1596 CheckFailed("'allocsize' " + Name +
1597 " argument must refer to an integer parameter",
1598 V);
1599 return false;
1600 }
1601
1602 return true;
1603 };
1604
1605 if (!CheckParam("element size", Args.first))
1606 return;
1607
1608 if (Args.second && !CheckParam("number of elements", *Args.second))
1609 return;
1610 }
Duncan Sands8c582282007-12-21 19:19:01 +00001611}
1612
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001613void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001614 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001615 for (const auto &Pair : MDs) {
1616 if (Pair.first == LLVMContext::MD_prof) {
1617 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001618 Assert(MD->getNumOperands() == 2,
1619 "!prof annotations should have exactly 2 operands", MD);
1620
1621 // Check first operand.
1622 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1623 MD);
1624 Assert(isa<MDString>(MD->getOperand(0)),
1625 "expected string with name of the !prof annotation", MD);
1626 MDString *MDS = cast<MDString>(MD->getOperand(0));
1627 StringRef ProfName = MDS->getString();
1628 Assert(ProfName.equals("function_entry_count"),
1629 "first operand should be 'function_entry_count'", MD);
1630
1631 // Check second operand.
1632 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1633 MD);
1634 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1635 "expected integer argument to function_entry_count", MD);
1636 }
1637 }
1638}
1639
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001640void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1641 if (!ConstantExprVisited.insert(EntryC).second)
1642 return;
1643
1644 SmallVector<const Constant *, 16> Stack;
1645 Stack.push_back(EntryC);
1646
1647 while (!Stack.empty()) {
1648 const Constant *C = Stack.pop_back_val();
1649
1650 // Check this constant expression.
1651 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1652 visitConstantExpr(CE);
1653
Keno Fischerf6d17b92016-01-14 22:42:02 +00001654 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1655 // Global Values get visited separately, but we do need to make sure
1656 // that the global value is in the correct module
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001657 Assert(GV->getParent() == &M, "Referencing global in another module!",
1658 EntryC, &M, GV, GV->getParent());
Keno Fischerf6d17b92016-01-14 22:42:02 +00001659 continue;
1660 }
1661
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001662 // Visit all sub-expressions.
1663 for (const Use &U : C->operands()) {
1664 const auto *OpC = dyn_cast<Constant>(U);
1665 if (!OpC)
1666 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001667 if (!ConstantExprVisited.insert(OpC).second)
1668 continue;
1669 Stack.push_back(OpC);
1670 }
1671 }
1672}
1673
1674void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001675 if (CE->getOpcode() == Instruction::BitCast)
1676 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1677 CE->getType()),
1678 "Invalid bitcast", CE);
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001679
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001680 if (CE->getOpcode() == Instruction::IntToPtr ||
1681 CE->getOpcode() == Instruction::PtrToInt) {
1682 auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
1683 ? CE->getType()
1684 : CE->getOperand(0)->getType();
1685 StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
1686 ? "inttoptr not supported for non-integral pointers"
1687 : "ptrtoint not supported for non-integral pointers";
1688 Assert(
1689 !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
1690 Msg);
1691 }
Matt Arsenault24b49c42013-07-31 17:49:08 +00001692}
1693
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001694bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001695 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001696 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001697
Devang Patel82fed672008-09-23 22:35:17 +00001698 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001699 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001700 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001701 || (LastIndex == AttributeSet::FunctionIndex
1702 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001703 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001704
Devang Patel82fed672008-09-23 22:35:17 +00001705 return false;
1706}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001707
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001708/// Verify that statepoint intrinsic is well formed.
1709void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001710 assert(CS.getCalledFunction() &&
1711 CS.getCalledFunction()->getIntrinsicID() ==
1712 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001713
Philip Reames0285c742015-02-03 23:18:47 +00001714 const Instruction &CI = *CS.getInstruction();
1715
Igor Laevsky39d662f2015-07-11 10:30:36 +00001716 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1717 !CS.onlyAccessesArgMemory(),
1718 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001719 "reordering restrictions required by safepoint semantics",
1720 &CI);
1721
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001722 const Value *IDV = CS.getArgument(0);
1723 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1724 &CI);
1725
1726 const Value *NumPatchBytesV = CS.getArgument(1);
1727 Assert(isa<ConstantInt>(NumPatchBytesV),
1728 "gc.statepoint number of patchable bytes must be a constant integer",
1729 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001730 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001731 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1732 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1733 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1734 "positive",
1735 &CI);
1736
1737 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001738 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001739 Assert(PT && PT->getElementType()->isFunctionTy(),
1740 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001741 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001742
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001743 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001744 Assert(isa<ConstantInt>(NumCallArgsV),
1745 "gc.statepoint number of arguments to underlying call "
1746 "must be constant integer",
1747 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001748 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001749 Assert(NumCallArgs >= 0,
1750 "gc.statepoint number of arguments to underlying call "
1751 "must be positive",
1752 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001753 const int NumParams = (int)TargetFuncType->getNumParams();
1754 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001755 Assert(NumCallArgs >= NumParams,
1756 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001757
1758 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001759 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1760 "gc.statepoint doesn't support wrapping non-void "
1761 "vararg functions yet",
1762 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001763 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001764 Assert(NumCallArgs == NumParams,
1765 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001766
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001767 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001768 Assert(isa<ConstantInt>(FlagsV),
1769 "gc.statepoint flags must be constant integer", &CI);
1770 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1771 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1772 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001773
1774 // Verify that the types of the call parameter arguments match
1775 // the type of the wrapped callee.
1776 for (int i = 0; i < NumParams; i++) {
1777 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001778 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001779 Assert(ArgType == ParamType,
1780 "gc.statepoint call argument does not match wrapped "
1781 "function type",
1782 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001783 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001784
1785 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001786
1787 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1788 Assert(isa<ConstantInt>(NumTransitionArgsV),
1789 "gc.statepoint number of transition arguments "
1790 "must be constant integer",
1791 &CI);
1792 const int NumTransitionArgs =
1793 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1794 Assert(NumTransitionArgs >= 0,
1795 "gc.statepoint number of transition arguments must be positive", &CI);
1796 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1797
1798 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001799 Assert(isa<ConstantInt>(NumDeoptArgsV),
1800 "gc.statepoint number of deoptimization arguments "
1801 "must be constant integer",
1802 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001803 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001804 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1805 "must be positive",
1806 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001807
Pat Gavlincc0431d2015-05-08 18:07:42 +00001808 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001809 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001810 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001811 "gc.statepoint too few arguments according to length fields", &CI);
1812
Philip Reames1ffa9372015-01-30 23:28:05 +00001813 // Check that the only uses of this gc.statepoint are gc.result or
1814 // gc.relocate calls which are tied to this statepoint and thus part
1815 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001816 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001817 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001818 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001819 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001820 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Sanjoy Das25fb5bd2016-08-11 00:56:46 +00001821 "gc.result or gc.relocate are the only value uses "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001822 "of a gc.statepoint",
1823 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001824 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001825 Assert(Call->getArgOperand(0) == &CI,
1826 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001827 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001828 Assert(Call->getArgOperand(0) == &CI,
1829 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001830 }
1831 }
1832
1833 // Note: It is legal for a single derived pointer to be listed multiple
1834 // times. It's non-optimal, but it is legal. It can also happen after
1835 // insertion if we strip a bitcast away.
1836 // Note: It is really tempting to check that each base is relocated and
1837 // that a derived pointer is never reused as a base pointer. This turns
1838 // out to be problematic since optimizations run after safepoint insertion
1839 // can recognize equality properties that the insertion logic doesn't know
1840 // about. See example statepoint.ll in the verifier subdirectory
1841}
1842
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001843void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001844 for (auto &Counts : FrameEscapeInfo) {
1845 Function *F = Counts.first;
1846 unsigned EscapedObjectCount = Counts.second.first;
1847 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001848 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001849 "all indices passed to llvm.localrecover must be less than the "
1850 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001851 "function",
1852 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001853 }
1854}
1855
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001856static Instruction *getSuccPad(TerminatorInst *Terminator) {
1857 BasicBlock *UnwindDest;
1858 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1859 UnwindDest = II->getUnwindDest();
1860 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1861 UnwindDest = CSI->getUnwindDest();
1862 else
1863 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1864 return UnwindDest->getFirstNonPHI();
1865}
1866
1867void Verifier::verifySiblingFuncletUnwinds() {
1868 SmallPtrSet<Instruction *, 8> Visited;
1869 SmallPtrSet<Instruction *, 8> Active;
1870 for (const auto &Pair : SiblingFuncletInfo) {
1871 Instruction *PredPad = Pair.first;
1872 if (Visited.count(PredPad))
1873 continue;
1874 Active.insert(PredPad);
1875 TerminatorInst *Terminator = Pair.second;
1876 do {
1877 Instruction *SuccPad = getSuccPad(Terminator);
1878 if (Active.count(SuccPad)) {
1879 // Found a cycle; report error
1880 Instruction *CyclePad = SuccPad;
1881 SmallVector<Instruction *, 8> CycleNodes;
1882 do {
1883 CycleNodes.push_back(CyclePad);
1884 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1885 if (CycleTerminator != CyclePad)
1886 CycleNodes.push_back(CycleTerminator);
1887 CyclePad = getSuccPad(CycleTerminator);
1888 } while (CyclePad != SuccPad);
1889 Assert(false, "EH pads can't handle each other's exceptions",
1890 ArrayRef<Instruction *>(CycleNodes));
1891 }
1892 // Don't re-walk a node we've already checked
1893 if (!Visited.insert(SuccPad).second)
1894 break;
1895 // Walk to this successor if it has a map entry.
1896 PredPad = SuccPad;
1897 auto TermI = SiblingFuncletInfo.find(PredPad);
1898 if (TermI == SiblingFuncletInfo.end())
1899 break;
1900 Terminator = TermI->second;
1901 Active.insert(PredPad);
1902 } while (true);
1903 // Each node only has one successor, so we've walked all the active
1904 // nodes' successors.
1905 Active.clear();
1906 }
1907}
1908
Chris Lattner0e851da2002-04-18 20:37:37 +00001909// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001910//
Chandler Carruth043949d2014-01-19 02:22:18 +00001911void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001912 visitGlobalValue(F);
1913
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001914 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001915 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001916 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001917
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001918 Assert(&Context == &F.getContext(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001919 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001920
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001921 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1922 Assert(FT->getNumParams() == NumArgs,
1923 "# formal arguments must match # of arguments for function type!", &F,
1924 FT);
1925 Assert(F.getReturnType()->isFirstClassType() ||
1926 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1927 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001928
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001929 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1930 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001931
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001932 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001933
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001934 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001935 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001936
Duncan Sands8c582282007-12-21 19:19:01 +00001937 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001938 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001939
Michael Gottesman41748d72013-06-27 00:25:01 +00001940 // On function declarations/definitions, we do not support the builtin
1941 // attribute. We do not check this in VerifyFunctionAttrs since that is
1942 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001943 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1944 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001945
Chris Lattneref13ee32006-05-19 21:25:17 +00001946 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001947 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1948 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001949 switch (F.getCallingConv()) {
1950 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001951 case CallingConv::C:
1952 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001953 case CallingConv::Fast:
1954 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001955 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001956 case CallingConv::PTX_Kernel:
1957 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001958 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1959 "perfect forwarding!",
1960 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001961 break;
1962 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001963
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001964 bool isLLVMdotName = F.getName().size() >= 5 &&
1965 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001966
Chris Lattneraf95e582002-04-13 22:48:46 +00001967 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001968 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001969 for (const Argument &Arg : F.args()) {
1970 Assert(Arg.getType() == FT->getParamType(i),
1971 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001972 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001973 Assert(Arg.getType()->isFirstClassType(),
1974 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00001975 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001976 Assert(!Arg.getType()->isMetadataTy(),
1977 "Function takes metadata but isn't an intrinsic", &Arg, &F);
1978 Assert(!Arg.getType()->isTokenTy(),
1979 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001980 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001981
1982 // Check that swifterror argument is only used by loads and stores.
1983 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
1984 verifySwiftErrorValue(&Arg);
1985 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001986 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00001987 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001988
David Majnemerb611e3f2015-08-14 05:09:07 +00001989 if (!isLLVMdotName)
1990 Assert(!F.getReturnType()->isTokenTy(),
1991 "Functions returns a token but isn't an intrinsic", &F);
1992
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001993 // Get the function metadata attachments.
1994 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1995 F.getAllMetadata(MDs);
1996 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001997 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001998
Keno Fischer2ac0c272015-11-16 05:13:30 +00001999 // Check validity of the personality function
2000 if (F.hasPersonalityFn()) {
2001 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
2002 if (Per)
2003 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00002004 "Referencing personality function in another module!",
2005 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00002006 }
2007
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002008 if (F.isMaterializable()) {
2009 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002010 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
2011 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002012 } else if (F.isDeclaration()) {
Peter Collingbourne21521892016-06-21 23:42:48 +00002013 for (const auto &I : MDs) {
2014 AssertDI(I.first != LLVMContext::MD_dbg,
2015 "function declaration may not have a !dbg attachment", &F);
2016 Assert(I.first != LLVMContext::MD_prof,
2017 "function declaration may not have a !prof attachment", &F);
2018
2019 // Verify the metadata itself.
2020 visitMDNode(*I.second);
2021 }
David Majnemer7fddecc2015-06-17 20:52:32 +00002022 Assert(!F.hasPersonalityFn(),
2023 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00002024 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00002025 // Verify that this function (which has a body) is not named "llvm.*". It
2026 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002027 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002028
Chris Lattner149376d2002-10-13 20:57:00 +00002029 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00002030 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002031 Assert(pred_empty(Entry),
2032 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002033
Chris Lattner27471742009-11-01 04:08:01 +00002034 // The address of the entry block cannot be taken, unless it is dead.
2035 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002036 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2037 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00002038 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002039
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002040 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002041 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002042 for (const auto &I : MDs) {
2043 // Verify that the attachment is legal.
2044 switch (I.first) {
2045 default:
2046 break;
2047 case LLVMContext::MD_dbg:
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002048 ++NumDebugAttachments;
2049 AssertDI(NumDebugAttachments == 1,
2050 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002051 AssertDI(isa<DISubprogram>(I.second),
2052 "function !dbg attachment must be a subprogram", &F, I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002053 break;
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002054 case LLVMContext::MD_prof:
2055 ++NumProfAttachments;
2056 Assert(NumProfAttachments == 1,
2057 "function must have a single !prof attachment", &F, I.second);
2058 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002059 }
2060
2061 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002062 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002063 }
Chris Lattner149376d2002-10-13 20:57:00 +00002064 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002065
Chris Lattner7730dcc2009-09-11 17:05:29 +00002066 // If this function is actually an intrinsic, verify that it is only used in
2067 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002068 // Only do this if the module is materialized, otherwise we don't have all the
2069 // uses.
2070 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002071 const User *U;
2072 if (F.hasAddressTaken(&U))
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002073 Assert(false, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002074 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002075
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002076 Assert(!F.hasDLLImportStorageClass() ||
2077 (F.isDeclaration() && F.hasExternalLinkage()) ||
2078 F.hasAvailableExternallyLinkage(),
2079 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002080
2081 auto *N = F.getSubprogram();
2082 if (!N)
2083 return;
2084
Adrian Prantl75819ae2016-04-15 15:57:41 +00002085 visitDISubprogram(*N);
2086
Peter Collingbourned4bff302015-11-05 22:03:56 +00002087 // Check that all !dbg attachments lead to back to N (or, at least, another
2088 // subprogram that describes the same function).
2089 //
2090 // FIXME: Check this incrementally while visiting !dbg attachments.
2091 // FIXME: Only check when N is the canonical subprogram for F.
2092 SmallPtrSet<const MDNode *, 32> Seen;
2093 for (auto &BB : F)
2094 for (auto &I : BB) {
2095 // Be careful about using DILocation here since we might be dealing with
2096 // broken code (this is the Verifier after all).
2097 DILocation *DL =
2098 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2099 if (!DL)
2100 continue;
2101 if (!Seen.insert(DL).second)
2102 continue;
2103
2104 DILocalScope *Scope = DL->getInlinedAtScope();
2105 if (Scope && !Seen.insert(Scope).second)
2106 continue;
2107
2108 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002109
2110 // Scope and SP could be the same MDNode and we don't want to skip
2111 // validation in that case
2112 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002113 continue;
2114
2115 // FIXME: Once N is canonical, check "SP == &N".
2116 Assert(SP->describes(&F),
2117 "!dbg attachment points at wrong subprogram for function", N, &F,
2118 &I, DL, Scope, SP);
2119 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002120}
2121
Chris Lattner0e851da2002-04-18 20:37:37 +00002122// verifyBasicBlock - Verify that a basic block is well formed...
2123//
Chris Lattner069a7952002-06-25 15:56:27 +00002124void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002125 InstsInThisBlock.clear();
2126
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002127 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002128 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002129
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002130 // Check constraints that this basic block imposes on all of the PHI nodes in
2131 // it.
2132 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002133 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2134 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002135 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002136 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002137 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002138 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002139 Assert(PN->getNumIncomingValues() != 0,
2140 "PHI nodes must have at least one entry. If the block is dead, "
2141 "the PHI should be removed!",
2142 PN);
2143 Assert(PN->getNumIncomingValues() == Preds.size(),
2144 "PHINode should have one entry for each predecessor of its "
2145 "parent basic block!",
2146 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002147
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002148 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002149 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002150 Values.reserve(PN->getNumIncomingValues());
2151 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2152 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2153 PN->getIncomingValue(i)));
2154 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002155
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002156 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2157 // Check to make sure that if there is more than one entry for a
2158 // particular basic block in this PHI node, that the incoming values are
2159 // all identical.
2160 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002161 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2162 Values[i].second == Values[i - 1].second,
2163 "PHI node has multiple entries for the same basic block with "
2164 "different incoming values!",
2165 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002166
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002167 // Check to make sure that the predecessors and PHI node entries are
2168 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002169 Assert(Values[i].first == Preds[i],
2170 "PHI node entries do not match predecessors!", PN,
2171 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002172 }
2173 }
2174 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002175
2176 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002177 for (auto &I : BB)
2178 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002179 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002180 }
Chris Lattner069a7952002-06-25 15:56:27 +00002181}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002182
Chris Lattner069a7952002-06-25 15:56:27 +00002183void Verifier::visitTerminatorInst(TerminatorInst &I) {
2184 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002185 Assert(&I == I.getParent()->getTerminator(),
2186 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002187 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002188}
2189
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002190void Verifier::visitBranchInst(BranchInst &BI) {
2191 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002192 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2193 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002194 }
2195 visitTerminatorInst(BI);
2196}
2197
Chris Lattner069a7952002-06-25 15:56:27 +00002198void Verifier::visitReturnInst(ReturnInst &RI) {
2199 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002200 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002201 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002202 Assert(N == 0,
2203 "Found return instr that returns non-void in Function of void "
2204 "return type!",
2205 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002206 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002207 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2208 "Function return type does not match operand "
2209 "type of return inst!",
2210 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002211
Misha Brukman7eb05a12003-08-18 14:43:39 +00002212 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002213 // terminators...
2214 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002215}
2216
Chris Lattnerab5aa142004-05-21 16:47:21 +00002217void Verifier::visitSwitchInst(SwitchInst &SI) {
2218 // Check to make sure that all of the constants in the switch instruction
2219 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002220 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002221 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002222 for (auto &Case : SI.cases()) {
2223 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002224 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002225 Assert(Constants.insert(Case.getCaseValue()).second,
2226 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002227 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002228
Chris Lattnerab5aa142004-05-21 16:47:21 +00002229 visitTerminatorInst(SI);
2230}
2231
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002232void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002233 Assert(BI.getAddress()->getType()->isPointerTy(),
2234 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002235 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002236 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2237 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002238
2239 visitTerminatorInst(BI);
2240}
2241
Chris Lattner75648e72004-03-12 05:54:31 +00002242void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002243 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2244 SI.getOperand(2)),
2245 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002246
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002247 Assert(SI.getTrueValue()->getType() == SI.getType(),
2248 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002249 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002250}
2251
Misha Brukmanc566ca362004-03-02 00:22:19 +00002252/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2253/// a pass, if any exist, it's an error.
2254///
Chris Lattner903a25d2002-11-21 16:54:22 +00002255void Verifier::visitUserOp1(Instruction &I) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002256 Assert(false, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002257}
Chris Lattner0e851da2002-04-18 20:37:37 +00002258
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002259void Verifier::visitTruncInst(TruncInst &I) {
2260 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002261 Type *SrcTy = I.getOperand(0)->getType();
2262 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002263
2264 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002265 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2266 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002267
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002268 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2269 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2270 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2271 "trunc source and destination must both be a vector or neither", &I);
2272 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002273
2274 visitInstruction(I);
2275}
2276
2277void Verifier::visitZExtInst(ZExtInst &I) {
2278 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002279 Type *SrcTy = I.getOperand(0)->getType();
2280 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002281
2282 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002283 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2284 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2285 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2286 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002287 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2288 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002289
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002290 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002291
2292 visitInstruction(I);
2293}
2294
2295void Verifier::visitSExtInst(SExtInst &I) {
2296 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002297 Type *SrcTy = I.getOperand(0)->getType();
2298 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002299
2300 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002301 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2302 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002303
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002304 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2305 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2306 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2307 "sext source and destination must both be a vector or neither", &I);
2308 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002309
2310 visitInstruction(I);
2311}
2312
2313void Verifier::visitFPTruncInst(FPTruncInst &I) {
2314 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002315 Type *SrcTy = I.getOperand(0)->getType();
2316 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002317 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002318 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2319 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002320
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002321 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2322 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2323 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2324 "fptrunc source and destination must both be a vector or neither", &I);
2325 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002326
2327 visitInstruction(I);
2328}
2329
2330void Verifier::visitFPExtInst(FPExtInst &I) {
2331 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002332 Type *SrcTy = I.getOperand(0)->getType();
2333 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002334
2335 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002336 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2337 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002338
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002339 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2340 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2341 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2342 "fpext source and destination must both be a vector or neither", &I);
2343 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002344
2345 visitInstruction(I);
2346}
2347
2348void Verifier::visitUIToFPInst(UIToFPInst &I) {
2349 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002350 Type *SrcTy = I.getOperand(0)->getType();
2351 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002352
Duncan Sands19d0b472010-02-16 11:11:14 +00002353 bool SrcVec = SrcTy->isVectorTy();
2354 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002355
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002356 Assert(SrcVec == DstVec,
2357 "UIToFP source and dest must both be vector or scalar", &I);
2358 Assert(SrcTy->isIntOrIntVectorTy(),
2359 "UIToFP source must be integer or integer vector", &I);
2360 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2361 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002362
2363 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002364 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2365 cast<VectorType>(DestTy)->getNumElements(),
2366 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002367
2368 visitInstruction(I);
2369}
2370
2371void Verifier::visitSIToFPInst(SIToFPInst &I) {
2372 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002373 Type *SrcTy = I.getOperand(0)->getType();
2374 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002375
Duncan Sands19d0b472010-02-16 11:11:14 +00002376 bool SrcVec = SrcTy->isVectorTy();
2377 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002378
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002379 Assert(SrcVec == DstVec,
2380 "SIToFP source and dest must both be vector or scalar", &I);
2381 Assert(SrcTy->isIntOrIntVectorTy(),
2382 "SIToFP source must be integer or integer vector", &I);
2383 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2384 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002385
2386 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002387 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2388 cast<VectorType>(DestTy)->getNumElements(),
2389 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002390
2391 visitInstruction(I);
2392}
2393
2394void Verifier::visitFPToUIInst(FPToUIInst &I) {
2395 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002396 Type *SrcTy = I.getOperand(0)->getType();
2397 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002398
Duncan Sands19d0b472010-02-16 11:11:14 +00002399 bool SrcVec = SrcTy->isVectorTy();
2400 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002401
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002402 Assert(SrcVec == DstVec,
2403 "FPToUI source and dest must both be vector or scalar", &I);
2404 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2405 &I);
2406 Assert(DestTy->isIntOrIntVectorTy(),
2407 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002408
2409 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002410 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2411 cast<VectorType>(DestTy)->getNumElements(),
2412 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002413
2414 visitInstruction(I);
2415}
2416
2417void Verifier::visitFPToSIInst(FPToSIInst &I) {
2418 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002419 Type *SrcTy = I.getOperand(0)->getType();
2420 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002421
Duncan Sands19d0b472010-02-16 11:11:14 +00002422 bool SrcVec = SrcTy->isVectorTy();
2423 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002424
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002425 Assert(SrcVec == DstVec,
2426 "FPToSI source and dest must both be vector or scalar", &I);
2427 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2428 &I);
2429 Assert(DestTy->isIntOrIntVectorTy(),
2430 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002431
2432 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002433 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2434 cast<VectorType>(DestTy)->getNumElements(),
2435 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002436
2437 visitInstruction(I);
2438}
2439
2440void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2441 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002442 Type *SrcTy = I.getOperand(0)->getType();
2443 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002444
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002445 Assert(SrcTy->getScalarType()->isPointerTy(),
2446 "PtrToInt source must be pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002447
2448 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002449 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002450 "ptrtoint not supported for non-integral pointers");
2451
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002452 Assert(DestTy->getScalarType()->isIntegerTy(),
2453 "PtrToInt result must be integral", &I);
2454 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2455 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002456
2457 if (SrcTy->isVectorTy()) {
2458 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2459 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002460 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2461 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002462 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002463
2464 visitInstruction(I);
2465}
2466
2467void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2468 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002469 Type *SrcTy = I.getOperand(0)->getType();
2470 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002471
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002472 Assert(SrcTy->getScalarType()->isIntegerTy(),
2473 "IntToPtr source must be an integral", &I);
2474 Assert(DestTy->getScalarType()->isPointerTy(),
2475 "IntToPtr result must be a pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002476
2477 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002478 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002479 "inttoptr not supported for non-integral pointers");
2480
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002481 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2482 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002483 if (SrcTy->isVectorTy()) {
2484 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2485 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002486 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2487 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002488 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002489 visitInstruction(I);
2490}
2491
2492void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002493 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002494 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2495 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002496 visitInstruction(I);
2497}
2498
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002499void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2500 Type *SrcTy = I.getOperand(0)->getType();
2501 Type *DestTy = I.getType();
2502
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002503 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2504 &I);
2505 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2506 &I);
2507 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2508 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002509 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002510 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2511 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002512 visitInstruction(I);
2513}
2514
Misha Brukmanc566ca362004-03-02 00:22:19 +00002515/// visitPHINode - Ensure that a PHI node is well formed.
2516///
Chris Lattner069a7952002-06-25 15:56:27 +00002517void Verifier::visitPHINode(PHINode &PN) {
2518 // Ensure that the PHI nodes are all grouped together at the top of the block.
2519 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002520 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002521 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002522 Assert(&PN == &PN.getParent()->front() ||
2523 isa<PHINode>(--BasicBlock::iterator(&PN)),
2524 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002525
David Majnemerb611e3f2015-08-14 05:09:07 +00002526 // Check that a PHI doesn't yield a Token.
2527 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2528
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002529 // Check that all of the values of the PHI node have the same type as the
2530 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002531 for (Value *IncValue : PN.incoming_values()) {
2532 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002533 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002534 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002535
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002536 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002537
2538 visitInstruction(PN);
2539}
2540
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002541void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002542 Instruction *I = CS.getInstruction();
2543
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002544 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2545 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002546 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002547
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002548 Assert(FPTy->getElementType()->isFunctionTy(),
2549 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002550
2551 Assert(FPTy->getElementType() == CS.getFunctionType(),
2552 "Called function is not the same type as the call!", I);
2553
2554 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002555
2556 // Verify that the correct number of arguments are being passed
2557 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002558 Assert(CS.arg_size() >= FTy->getNumParams(),
2559 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002560 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002561 Assert(CS.arg_size() == FTy->getNumParams(),
2562 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002563
Chris Lattner609de002010-05-10 20:58:42 +00002564 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002565 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002566 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2567 "Call parameter type does not match function signature!",
2568 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002569
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002570 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002571
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002572 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002573 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002574
Duncan Sands8c582282007-12-21 19:19:01 +00002575 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002576 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002577
David Majnemer91db08b2014-04-30 17:22:00 +00002578 // Conservatively check the inalloca argument.
2579 // We have a bug if we can find that there is an underlying alloca without
2580 // inalloca.
2581 if (CS.hasInAllocaArgument()) {
2582 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2583 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002584 Assert(AI->isUsedWithInAlloca(),
2585 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002586 }
2587
Manman Ren9bfd0d02016-04-01 21:41:15 +00002588 // For each argument of the callsite, if it has the swifterror argument,
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002589 // make sure the underlying alloca/parameter it comes from has a swifterror as
2590 // well.
Manman Ren9bfd0d02016-04-01 21:41:15 +00002591 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2592 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2593 Value *SwiftErrorArg = CS.getArgument(i);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002594 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002595 Assert(AI->isSwiftError(),
2596 "swifterror argument for call has mismatched alloca", AI, I);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002597 continue;
2598 }
2599 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
2600 Assert(ArgI, "swifterror argument should come from an alloca or parameter", SwiftErrorArg, I);
2601 Assert(ArgI->hasSwiftErrorAttr(),
2602 "swifterror argument for call has mismatched parameter", ArgI, I);
Manman Ren9bfd0d02016-04-01 21:41:15 +00002603 }
2604
Stephen Linb8bd2322013-04-20 05:14:40 +00002605 if (FTy->isVarArg()) {
2606 // FIXME? is 'nest' even legal here?
2607 bool SawNest = false;
2608 bool SawReturned = false;
2609
2610 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2611 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2612 SawNest = true;
2613 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2614 SawReturned = true;
2615 }
2616
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002617 // Check attributes on the varargs part.
2618 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002619 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002620 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002621
Stephen Linb8bd2322013-04-20 05:14:40 +00002622 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002623 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002624 SawNest = true;
2625 }
2626
2627 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002628 Assert(!SawReturned, "More than one parameter has attribute returned!",
2629 I);
2630 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2631 "Incompatible argument and return types for 'returned' "
2632 "attribute",
2633 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002634 SawReturned = true;
2635 }
Duncan Sands0009c442008-01-12 16:42:01 +00002636
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002637 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2638 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002639
2640 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002641 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002642 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002643 }
Duncan Sands8c582282007-12-21 19:19:01 +00002644
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002645 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002646 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002647 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002648 for (Type *ParamTy : FTy->params()) {
2649 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002650 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002651 Assert(!ParamTy->isTokenTy(),
2652 "Function has token parameter but isn't an intrinsic", I);
2653 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002654 }
2655
David Majnemerb611e3f2015-08-14 05:09:07 +00002656 // Verify that indirect calls don't return tokens.
2657 if (CS.getCalledFunction() == nullptr)
2658 Assert(!FTy->getReturnType()->isTokenTy(),
2659 "Return type cannot be token for indirect call!");
2660
Philip Reamesa3c6f002015-06-26 21:39:44 +00002661 if (Function *F = CS.getCalledFunction())
2662 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002663 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002664
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002665 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2666 // at most one "gc-transition" operand bundle.
2667 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2668 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002669 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002670 OperandBundleUse BU = CS.getOperandBundleAt(i);
2671 uint32_t Tag = BU.getTagID();
2672 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002673 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2674 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002675 } else if (Tag == LLVMContext::OB_gc_transition) {
2676 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2677 I);
2678 FoundGCTransitionBundle = true;
2679 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002680 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2681 FoundFuncletBundle = true;
2682 Assert(BU.Inputs.size() == 1,
2683 "Expected exactly one funclet bundle operand", I);
2684 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2685 "Funclet bundle operands should correspond to a FuncletPadInst",
2686 I);
2687 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002688 }
2689
Adrian Prantl93035c82016-04-24 22:23:13 +00002690 // Verify that each inlinable callsite of a debug-info-bearing function in a
2691 // debug-info-bearing function has a debug location attached to it. Failure to
2692 // do so causes assertion failures when the inliner sets up inline scope info.
2693 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2694 CS.getCalledFunction()->getSubprogram())
2695 Assert(I->getDebugLoc(), "inlinable function call in a function with debug "
2696 "info must have a !dbg location",
2697 I);
2698
Duncan Sands8c582282007-12-21 19:19:01 +00002699 visitInstruction(*I);
2700}
2701
Reid Kleckner5772b772014-04-24 20:14:34 +00002702/// Two types are "congruent" if they are identical, or if they are both pointer
2703/// types with different pointee types and the same address space.
2704static bool isTypeCongruent(Type *L, Type *R) {
2705 if (L == R)
2706 return true;
2707 PointerType *PL = dyn_cast<PointerType>(L);
2708 PointerType *PR = dyn_cast<PointerType>(R);
2709 if (!PL || !PR)
2710 return false;
2711 return PL->getAddressSpace() == PR->getAddressSpace();
2712}
2713
Reid Klecknerd20c9702014-05-15 23:58:57 +00002714static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2715 static const Attribute::AttrKind ABIAttrs[] = {
2716 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002717 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2718 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002719 AttrBuilder Copy;
2720 for (auto AK : ABIAttrs) {
2721 if (Attrs.hasAttribute(I + 1, AK))
2722 Copy.addAttribute(AK);
2723 }
2724 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2725 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2726 return Copy;
2727}
2728
Reid Kleckner5772b772014-04-24 20:14:34 +00002729void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002730 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002731
2732 // - The caller and callee prototypes must match. Pointer types of
2733 // parameters or return types may differ in pointee type, but not
2734 // address space.
2735 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002736 FunctionType *CallerTy = F->getFunctionType();
2737 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002738 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2739 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2740 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2741 "cannot guarantee tail call due to mismatched varargs", &CI);
2742 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2743 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002744 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002745 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002746 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2747 "cannot guarantee tail call due to mismatched parameter types", &CI);
2748 }
2749
2750 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002751 Assert(F->getCallingConv() == CI.getCallingConv(),
2752 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002753
2754 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2755 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002756 AttributeSet CallerAttrs = F->getAttributes();
2757 AttributeSet CalleeAttrs = CI.getAttributes();
2758 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002759 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2760 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002761 Assert(CallerABIAttrs == CalleeABIAttrs,
2762 "cannot guarantee tail call due to mismatched ABI impacting "
2763 "function attributes",
2764 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002765 }
2766
2767 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2768 // or a pointer bitcast followed by a ret instruction.
2769 // - The ret instruction must return the (possibly bitcasted) value
2770 // produced by the call or void.
2771 Value *RetVal = &CI;
2772 Instruction *Next = CI.getNextNode();
2773
2774 // Handle the optional bitcast.
2775 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002776 Assert(BI->getOperand(0) == RetVal,
2777 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002778 RetVal = BI;
2779 Next = BI->getNextNode();
2780 }
2781
2782 // Check the return.
2783 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002784 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2785 &CI);
2786 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2787 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002788}
2789
Duncan Sands8c582282007-12-21 19:19:01 +00002790void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002791 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002792
Reid Kleckner5772b772014-04-24 20:14:34 +00002793 if (CI.isMustTailCall())
2794 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002795}
2796
2797void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002798 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002799
David Majnemer654e1302015-07-31 17:58:14 +00002800 // Verify that the first non-PHI instruction of the unwind destination is an
2801 // exception handling instruction.
2802 Assert(
2803 II.getUnwindDest()->isEHPad(),
2804 "The unwind destination does not have an exception handling instruction!",
2805 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002806
Dan Gohman9c6e1882010-08-02 23:09:14 +00002807 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002808}
Chris Lattner0e851da2002-04-18 20:37:37 +00002809
Misha Brukmanc566ca362004-03-02 00:22:19 +00002810/// visitBinaryOperator - Check that both arguments to the binary operator are
2811/// of the same type!
2812///
Chris Lattner069a7952002-06-25 15:56:27 +00002813void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002814 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2815 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002816
Reid Spencer2341c222007-02-02 02:16:23 +00002817 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002818 // Check that integer arithmetic operators are only used with
2819 // integral operands.
2820 case Instruction::Add:
2821 case Instruction::Sub:
2822 case Instruction::Mul:
2823 case Instruction::SDiv:
2824 case Instruction::UDiv:
2825 case Instruction::SRem:
2826 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002827 Assert(B.getType()->isIntOrIntVectorTy(),
2828 "Integer arithmetic operators only work with integral types!", &B);
2829 Assert(B.getType() == B.getOperand(0)->getType(),
2830 "Integer arithmetic operators must have same type "
2831 "for operands and result!",
2832 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002833 break;
2834 // Check that floating-point arithmetic operators are only used with
2835 // floating-point operands.
2836 case Instruction::FAdd:
2837 case Instruction::FSub:
2838 case Instruction::FMul:
2839 case Instruction::FDiv:
2840 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002841 Assert(B.getType()->isFPOrFPVectorTy(),
2842 "Floating-point arithmetic operators only work with "
2843 "floating-point types!",
2844 &B);
2845 Assert(B.getType() == B.getOperand(0)->getType(),
2846 "Floating-point arithmetic operators must have same type "
2847 "for operands and result!",
2848 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002849 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002850 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002851 case Instruction::And:
2852 case Instruction::Or:
2853 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002854 Assert(B.getType()->isIntOrIntVectorTy(),
2855 "Logical operators only work with integral types!", &B);
2856 Assert(B.getType() == B.getOperand(0)->getType(),
2857 "Logical operators must have same type for operands and result!",
2858 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002859 break;
2860 case Instruction::Shl:
2861 case Instruction::LShr:
2862 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002863 Assert(B.getType()->isIntOrIntVectorTy(),
2864 "Shifts only work with integral types!", &B);
2865 Assert(B.getType() == B.getOperand(0)->getType(),
2866 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002867 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002868 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002869 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002870 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002871
Chris Lattner0e851da2002-04-18 20:37:37 +00002872 visitInstruction(B);
2873}
2874
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002875void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002876 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002877 Type *Op0Ty = IC.getOperand(0)->getType();
2878 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002879 Assert(Op0Ty == Op1Ty,
2880 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002881 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002882 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2883 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002884 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002885 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2886 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2887 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002888
Reid Spencerd9436b62006-11-20 01:22:35 +00002889 visitInstruction(IC);
2890}
2891
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002892void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002893 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002894 Type *Op0Ty = FC.getOperand(0)->getType();
2895 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002896 Assert(Op0Ty == Op1Ty,
2897 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002898 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002899 Assert(Op0Ty->isFPOrFPVectorTy(),
2900 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002901 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002902 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2903 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2904 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002905
Reid Spencerd9436b62006-11-20 01:22:35 +00002906 visitInstruction(FC);
2907}
2908
Robert Bocchino23004482006-01-10 19:05:34 +00002909void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002910 Assert(
2911 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2912 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002913 visitInstruction(EI);
2914}
2915
Robert Bocchinoca27f032006-01-17 20:07:22 +00002916void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002917 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2918 IE.getOperand(2)),
2919 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002920 visitInstruction(IE);
2921}
2922
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002923void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002924 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2925 SV.getOperand(2)),
2926 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002927 visitInstruction(SV);
2928}
2929
Chris Lattner069a7952002-06-25 15:56:27 +00002930void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002931 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002932
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002933 Assert(isa<PointerType>(TargetTy),
2934 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002935 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002936 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002937 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002938 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002939 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002940
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002941 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002942 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002943 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002944
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002945 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002946 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002947 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2948 if (GEP.getPointerOperandType()->isVectorTy())
2949 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2950 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002951 for (Value *Idx : Idxs) {
2952 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002953 if (IndexTy->isVectorTy()) {
2954 unsigned IndexWidth = IndexTy->getVectorNumElements();
2955 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2956 }
2957 Assert(IndexTy->getScalarType()->isIntegerTy(),
2958 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002959 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002960 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002961 visitInstruction(GEP);
2962}
2963
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002964static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2965 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2966}
2967
Philip Reamesbf9676f2014-10-20 23:52:07 +00002968void Verifier::visitRangeMetadata(Instruction& I,
2969 MDNode* Range, Type* Ty) {
2970 assert(Range &&
2971 Range == I.getMetadata(LLVMContext::MD_range) &&
2972 "precondition violation");
2973
2974 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002975 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002976 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002977 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2978
Philip Reamesbf9676f2014-10-20 23:52:07 +00002979 ConstantRange LastRange(1); // Dummy initial value
2980 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002981 ConstantInt *Low =
2982 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002983 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002984 ConstantInt *High =
2985 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002986 Assert(High, "The upper limit must be an integer!", High);
2987 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2988 "Range types must match instruction type!", &I);
2989
Philip Reamesbf9676f2014-10-20 23:52:07 +00002990 APInt HighV = High->getValue();
2991 APInt LowV = Low->getValue();
2992 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002993 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2994 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002995 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002996 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2997 "Intervals are overlapping", Range);
2998 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2999 Range);
3000 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
3001 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003002 }
3003 LastRange = ConstantRange(LowV, HighV);
3004 }
3005 if (NumRanges > 2) {
3006 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003007 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003008 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003009 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003010 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003011 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
3012 "Intervals are overlapping", Range);
3013 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
3014 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003015 }
3016}
3017
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003018void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
3019 unsigned Size = DL.getTypeSizeInBits(Ty);
JF Bastiend1fb5852015-12-17 22:09:19 +00003020 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
3021 Assert(!(Size & (Size - 1)),
3022 "atomic memory access' operand must have a power-of-two size", Ty, I);
3023}
3024
Chris Lattner069a7952002-06-25 15:56:27 +00003025void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003026 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003027 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00003028 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003029 Assert(LI.getAlignment() <= Value::MaximumAlignment,
3030 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003031 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003032 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003033 Assert(LI.getOrdering() != AtomicOrdering::Release &&
3034 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003035 "Load cannot have Release ordering", &LI);
3036 Assert(LI.getAlignment() != 0,
3037 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003038 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3039 ElTy->isFloatingPointTy(),
3040 "atomic load operand must have integer, pointer, or floating point "
3041 "type!",
3042 ElTy, &LI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003043 checkAtomicMemAccessSize(ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003044 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003045 Assert(LI.getSynchScope() == CrossThread,
3046 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003047 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003048
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003049 visitInstruction(LI);
3050}
3051
Chris Lattner069a7952002-06-25 15:56:27 +00003052void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003053 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003054 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00003055 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003056 Assert(ElTy == SI.getOperand(0)->getType(),
3057 "Stored value type does not match pointer operand type!", &SI, ElTy);
3058 Assert(SI.getAlignment() <= Value::MaximumAlignment,
3059 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003060 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003061 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003062 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3063 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003064 "Store cannot have Acquire ordering", &SI);
3065 Assert(SI.getAlignment() != 0,
3066 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003067 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3068 ElTy->isFloatingPointTy(),
3069 "atomic store operand must have integer, pointer, or floating point "
3070 "type!",
3071 ElTy, &SI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003072 checkAtomicMemAccessSize(ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003073 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003074 Assert(SI.getSynchScope() == CrossThread,
3075 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003076 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003077 visitInstruction(SI);
3078}
3079
Manman Ren9bfd0d02016-04-01 21:41:15 +00003080/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3081void Verifier::verifySwiftErrorCallSite(CallSite CS,
3082 const Value *SwiftErrorVal) {
3083 unsigned Idx = 0;
3084 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3085 I != E; ++I, ++Idx) {
3086 if (*I == SwiftErrorVal) {
3087 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3088 "swifterror value when used in a callsite should be marked "
3089 "with swifterror attribute",
3090 SwiftErrorVal, CS);
3091 }
3092 }
3093}
3094
3095void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3096 // Check that swifterror value is only used by loads, stores, or as
3097 // a swifterror argument.
3098 for (const User *U : SwiftErrorVal->users()) {
3099 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3100 isa<InvokeInst>(U),
3101 "swifterror value can only be loaded and stored from, or "
3102 "as a swifterror argument!",
3103 SwiftErrorVal, U);
3104 // If it is used by a store, check it is the second operand.
3105 if (auto StoreI = dyn_cast<StoreInst>(U))
3106 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3107 "swifterror value should be the second operand when used "
3108 "by stores", SwiftErrorVal, U);
3109 if (auto CallI = dyn_cast<CallInst>(U))
3110 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3111 if (auto II = dyn_cast<InvokeInst>(U))
3112 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3113 }
3114}
3115
Victor Hernandez8acf2952009-10-23 21:09:37 +00003116void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003117 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003118 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003119 Assert(PTy->getAddressSpace() == 0,
3120 "Allocation instruction pointer not in the generic address space!",
3121 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003122 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003123 "Cannot allocate unsized type", &AI);
3124 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3125 "Alloca array size must have integer type", &AI);
3126 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3127 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003128
Manman Ren9bfd0d02016-04-01 21:41:15 +00003129 if (AI.isSwiftError()) {
3130 verifySwiftErrorValue(&AI);
3131 }
3132
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003133 visitInstruction(AI);
3134}
3135
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003136void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003137
3138 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003139 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003140 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003141 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003142 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003143 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003144 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003145 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003146 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003147 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3148 "cmpxchg instructions failure argument shall be no stronger than the "
3149 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003150 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003151 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3152 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003153 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003154
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003155 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003156 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003157 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003158 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3159 "cmpxchg operand must have integer or pointer type",
3160 ElTy, &CXI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003161 checkAtomicMemAccessSize(ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003162 Assert(ElTy == CXI.getOperand(1)->getType(),
3163 "Expected value type does not match pointer operand type!", &CXI,
3164 ElTy);
3165 Assert(ElTy == CXI.getOperand(2)->getType(),
3166 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003167 visitInstruction(CXI);
3168}
3169
3170void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003171 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003172 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003173 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003174 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003175 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003176 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003177 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003178 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3179 &RMWI, ElTy);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003180 checkAtomicMemAccessSize(ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003181 Assert(ElTy == RMWI.getOperand(1)->getType(),
3182 "Argument value type does not match pointer operand type!", &RMWI,
3183 ElTy);
3184 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3185 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3186 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003187 visitInstruction(RMWI);
3188}
3189
Eli Friedmanfee02c62011-07-25 23:16:38 +00003190void Verifier::visitFenceInst(FenceInst &FI) {
3191 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003192 Assert(Ordering == AtomicOrdering::Acquire ||
3193 Ordering == AtomicOrdering::Release ||
3194 Ordering == AtomicOrdering::AcquireRelease ||
3195 Ordering == AtomicOrdering::SequentiallyConsistent,
3196 "fence instructions may only have acquire, release, acq_rel, or "
3197 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003198 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003199 visitInstruction(FI);
3200}
3201
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003202void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003203 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3204 EVI.getIndices()) == EVI.getType(),
3205 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003206
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003207 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003208}
3209
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003210void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003211 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3212 IVI.getIndices()) ==
3213 IVI.getOperand(1)->getType(),
3214 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003215
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003216 visitInstruction(IVI);
3217}
Chris Lattner0e851da2002-04-18 20:37:37 +00003218
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003219static Value *getParentPad(Value *EHPad) {
3220 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3221 return FPI->getParentPad();
3222
3223 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3224}
3225
David Majnemer85a549d2015-08-11 02:48:30 +00003226void Verifier::visitEHPadPredecessors(Instruction &I) {
3227 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003228
David Majnemer85a549d2015-08-11 02:48:30 +00003229 BasicBlock *BB = I.getParent();
3230 Function *F = BB->getParent();
3231
3232 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3233
3234 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3235 // The landingpad instruction defines its parent as a landing pad block. The
3236 // landing pad block may be branched to only by the unwind edge of an
3237 // invoke.
3238 for (BasicBlock *PredBB : predecessors(BB)) {
3239 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3240 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3241 "Block containing LandingPadInst must be jumped to "
3242 "only by the unwind edge of an invoke.",
3243 LPI);
3244 }
3245 return;
3246 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003247 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3248 if (!pred_empty(BB))
3249 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3250 "Block containg CatchPadInst must be jumped to "
3251 "only by its catchswitch.",
3252 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003253 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3254 "Catchswitch cannot unwind to one of its catchpads",
3255 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003256 return;
3257 }
David Majnemer85a549d2015-08-11 02:48:30 +00003258
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003259 // Verify that each pred has a legal terminator with a legal to/from EH
3260 // pad relationship.
3261 Instruction *ToPad = &I;
3262 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003263 for (BasicBlock *PredBB : predecessors(BB)) {
3264 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003265 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003266 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003267 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003268 "EH pad must be jumped to via an unwind edge", ToPad, II);
3269 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3270 FromPad = Bundle->Inputs[0];
3271 else
3272 FromPad = ConstantTokenNone::get(II->getContext());
3273 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003274 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003275 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3276 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3277 FromPad = CSI;
3278 } else {
3279 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3280 }
3281
3282 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003283 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003284 for (;; FromPad = getParentPad(FromPad)) {
3285 Assert(FromPad != ToPad,
3286 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3287 if (FromPad == ToPadParent) {
3288 // This is a legal unwind edge.
3289 break;
3290 }
3291 Assert(!isa<ConstantTokenNone>(FromPad),
3292 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003293 Assert(Seen.insert(FromPad).second,
3294 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003295 }
David Majnemer85a549d2015-08-11 02:48:30 +00003296 }
3297}
3298
3299void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003300 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3301 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003302 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3303 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003304
David Majnemer85a549d2015-08-11 02:48:30 +00003305 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003306
David Majnemer654e1302015-07-31 17:58:14 +00003307 if (!LandingPadResultTy)
3308 LandingPadResultTy = LPI.getType();
3309 else
3310 Assert(LandingPadResultTy == LPI.getType(),
3311 "The landingpad instruction should have a consistent result type "
3312 "inside a function.",
3313 &LPI);
3314
David Majnemer7fddecc2015-06-17 20:52:32 +00003315 Function *F = LPI.getParent()->getParent();
3316 Assert(F->hasPersonalityFn(),
3317 "LandingPadInst needs to be in a function with a personality.", &LPI);
3318
Bill Wendlingfae14752011-08-12 20:24:12 +00003319 // The landingpad instruction must be the first non-PHI instruction in the
3320 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003321 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3322 "LandingPadInst not the first non-PHI instruction in the block.",
3323 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003324
Duncan Sands86de1a62011-09-27 16:43:19 +00003325 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003326 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003327 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003328 Assert(isa<PointerType>(Clause->getType()),
3329 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003330 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003331 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3332 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3333 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003334 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003335 }
3336
Bill Wendlingfae14752011-08-12 20:24:12 +00003337 visitInstruction(LPI);
3338}
3339
David Majnemerba6665d2016-08-01 18:06:34 +00003340void Verifier::visitResumeInst(ResumeInst &RI) {
3341 Assert(RI.getFunction()->hasPersonalityFn(),
3342 "ResumeInst needs to be in a function with a personality.", &RI);
3343
3344 if (!LandingPadResultTy)
3345 LandingPadResultTy = RI.getValue()->getType();
3346 else
3347 Assert(LandingPadResultTy == RI.getValue()->getType(),
3348 "The resume instruction should have a consistent result type "
3349 "inside a function.",
3350 &RI);
3351
3352 visitTerminatorInst(RI);
3353}
3354
David Majnemer654e1302015-07-31 17:58:14 +00003355void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003356 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003357
David Majnemer654e1302015-07-31 17:58:14 +00003358 Function *F = BB->getParent();
3359 Assert(F->hasPersonalityFn(),
3360 "CatchPadInst needs to be in a function with a personality.", &CPI);
3361
David Majnemer8a1c45d2015-12-12 05:38:55 +00003362 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3363 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3364 CPI.getParentPad());
3365
David Majnemer654e1302015-07-31 17:58:14 +00003366 // The catchpad instruction must be the first non-PHI instruction in the
3367 // block.
3368 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003369 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003370
David Majnemerfe2f7f32016-02-29 22:56:36 +00003371 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003372 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003373}
3374
David Majnemer8a1c45d2015-12-12 05:38:55 +00003375void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3376 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3377 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3378 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003379
David Majnemer8a1c45d2015-12-12 05:38:55 +00003380 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003381}
3382
3383void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3384 BasicBlock *BB = CPI.getParent();
3385
David Majnemer654e1302015-07-31 17:58:14 +00003386 Function *F = BB->getParent();
3387 Assert(F->hasPersonalityFn(),
3388 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3389
3390 // The cleanuppad instruction must be the first non-PHI instruction in the
3391 // block.
3392 Assert(BB->getFirstNonPHI() == &CPI,
3393 "CleanupPadInst not the first non-PHI instruction in the block.",
3394 &CPI);
3395
David Majnemer8a1c45d2015-12-12 05:38:55 +00003396 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003397 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003398 "CleanupPadInst has an invalid parent.", &CPI);
3399
David Majnemerfe2f7f32016-02-29 22:56:36 +00003400 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003401 visitFuncletPadInst(CPI);
3402}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003403
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003404void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3405 User *FirstUser = nullptr;
3406 Value *FirstUnwindPad = nullptr;
3407 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003408 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003409
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003410 while (!Worklist.empty()) {
3411 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003412 Assert(Seen.insert(CurrentPad).second,
3413 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003414 Value *UnresolvedAncestorPad = nullptr;
3415 for (User *U : CurrentPad->users()) {
3416 BasicBlock *UnwindDest;
3417 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3418 UnwindDest = CRI->getUnwindDest();
3419 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3420 // We allow catchswitch unwind to caller to nest
3421 // within an outer pad that unwinds somewhere else,
3422 // because catchswitch doesn't have a nounwind variant.
3423 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3424 if (CSI->unwindsToCaller())
3425 continue;
3426 UnwindDest = CSI->getUnwindDest();
3427 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3428 UnwindDest = II->getUnwindDest();
3429 } else if (isa<CallInst>(U)) {
3430 // Calls which don't unwind may be found inside funclet
3431 // pads that unwind somewhere else. We don't *require*
3432 // such calls to be annotated nounwind.
3433 continue;
3434 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3435 // The unwind dest for a cleanup can only be found by
3436 // recursive search. Add it to the worklist, and we'll
3437 // search for its first use that determines where it unwinds.
3438 Worklist.push_back(CPI);
3439 continue;
3440 } else {
3441 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3442 continue;
3443 }
3444
3445 Value *UnwindPad;
3446 bool ExitsFPI;
3447 if (UnwindDest) {
3448 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003449 if (!cast<Instruction>(UnwindPad)->isEHPad())
3450 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003451 Value *UnwindParent = getParentPad(UnwindPad);
3452 // Ignore unwind edges that don't exit CurrentPad.
3453 if (UnwindParent == CurrentPad)
3454 continue;
3455 // Determine whether the original funclet pad is exited,
3456 // and if we are scanning nested pads determine how many
3457 // of them are exited so we can stop searching their
3458 // children.
3459 Value *ExitedPad = CurrentPad;
3460 ExitsFPI = false;
3461 do {
3462 if (ExitedPad == &FPI) {
3463 ExitsFPI = true;
3464 // Now we can resolve any ancestors of CurrentPad up to
3465 // FPI, but not including FPI since we need to make sure
3466 // to check all direct users of FPI for consistency.
3467 UnresolvedAncestorPad = &FPI;
3468 break;
3469 }
3470 Value *ExitedParent = getParentPad(ExitedPad);
3471 if (ExitedParent == UnwindParent) {
3472 // ExitedPad is the ancestor-most pad which this unwind
3473 // edge exits, so we can resolve up to it, meaning that
3474 // ExitedParent is the first ancestor still unresolved.
3475 UnresolvedAncestorPad = ExitedParent;
3476 break;
3477 }
3478 ExitedPad = ExitedParent;
3479 } while (!isa<ConstantTokenNone>(ExitedPad));
3480 } else {
3481 // Unwinding to caller exits all pads.
3482 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3483 ExitsFPI = true;
3484 UnresolvedAncestorPad = &FPI;
3485 }
3486
3487 if (ExitsFPI) {
3488 // This unwind edge exits FPI. Make sure it agrees with other
3489 // such edges.
3490 if (FirstUser) {
3491 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3492 "pad must have the same unwind "
3493 "dest",
3494 &FPI, U, FirstUser);
3495 } else {
3496 FirstUser = U;
3497 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003498 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3499 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3500 getParentPad(UnwindPad) == getParentPad(&FPI))
3501 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003502 }
3503 }
3504 // Make sure we visit all uses of FPI, but for nested pads stop as
3505 // soon as we know where they unwind to.
3506 if (CurrentPad != &FPI)
3507 break;
3508 }
3509 if (UnresolvedAncestorPad) {
3510 if (CurrentPad == UnresolvedAncestorPad) {
3511 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3512 // we've found an unwind edge that exits it, because we need to verify
3513 // all direct uses of FPI.
3514 assert(CurrentPad == &FPI);
3515 continue;
3516 }
3517 // Pop off the worklist any nested pads that we've found an unwind
3518 // destination for. The pads on the worklist are the uncles,
3519 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3520 // for all ancestors of CurrentPad up to but not including
3521 // UnresolvedAncestorPad.
3522 Value *ResolvedPad = CurrentPad;
3523 while (!Worklist.empty()) {
3524 Value *UnclePad = Worklist.back();
3525 Value *AncestorPad = getParentPad(UnclePad);
3526 // Walk ResolvedPad up the ancestor list until we either find the
3527 // uncle's parent or the last resolved ancestor.
3528 while (ResolvedPad != AncestorPad) {
3529 Value *ResolvedParent = getParentPad(ResolvedPad);
3530 if (ResolvedParent == UnresolvedAncestorPad) {
3531 break;
3532 }
3533 ResolvedPad = ResolvedParent;
3534 }
3535 // If the resolved ancestor search didn't find the uncle's parent,
3536 // then the uncle is not yet resolved.
3537 if (ResolvedPad != AncestorPad)
3538 break;
3539 // This uncle is resolved, so pop it from the worklist.
3540 Worklist.pop_back();
3541 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003542 }
3543 }
3544
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003545 if (FirstUnwindPad) {
3546 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3547 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3548 Value *SwitchUnwindPad;
3549 if (SwitchUnwindDest)
3550 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3551 else
3552 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3553 Assert(SwitchUnwindPad == FirstUnwindPad,
3554 "Unwind edges out of a catch must have the same unwind dest as "
3555 "the parent catchswitch",
3556 &FPI, FirstUser, CatchSwitch);
3557 }
3558 }
3559
3560 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003561}
3562
David Majnemer8a1c45d2015-12-12 05:38:55 +00003563void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003564 BasicBlock *BB = CatchSwitch.getParent();
3565
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003566 Function *F = BB->getParent();
3567 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003568 "CatchSwitchInst needs to be in a function with a personality.",
3569 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003570
David Majnemer8a1c45d2015-12-12 05:38:55 +00003571 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003572 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003573 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3574 "CatchSwitchInst not the first non-PHI instruction in the block.",
3575 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003576
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003577 auto *ParentPad = CatchSwitch.getParentPad();
3578 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3579 "CatchSwitchInst has an invalid parent.", ParentPad);
3580
David Majnemer8a1c45d2015-12-12 05:38:55 +00003581 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003582 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003583 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3584 "CatchSwitchInst must unwind to an EH block which is not a "
3585 "landingpad.",
3586 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003587
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003588 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3589 if (getParentPad(I) == ParentPad)
3590 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3591 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003592
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003593 Assert(CatchSwitch.getNumHandlers() != 0,
3594 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3595
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003596 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003597 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3598 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003599 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003600
David Majnemerfe2f7f32016-02-29 22:56:36 +00003601 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003602 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003603}
3604
David Majnemer654e1302015-07-31 17:58:14 +00003605void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003606 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3607 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3608 CRI.getOperand(0));
3609
David Majnemer654e1302015-07-31 17:58:14 +00003610 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3611 Instruction *I = UnwindDest->getFirstNonPHI();
3612 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3613 "CleanupReturnInst must unwind to an EH block which is not a "
3614 "landingpad.",
3615 &CRI);
3616 }
3617
3618 visitTerminatorInst(CRI);
3619}
3620
Rafael Espindola654320a2012-02-26 02:23:37 +00003621void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3622 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003623 // If the we have an invalid invoke, don't try to compute the dominance.
3624 // We already reject it in the invoke specific checks and the dominance
3625 // computation doesn't handle multiple edges.
3626 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3627 if (II->getNormalDest() == II->getUnwindDest())
3628 return;
3629 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003630
Michael Kruseff379b62016-03-26 23:32:57 +00003631 // Quick check whether the def has already been encountered in the same block.
3632 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3633 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003634 //
3635 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3636 // wrapping an SSA value, assert that we've already encountered it. See
3637 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003638 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3639 return;
3640
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003641 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003642 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003643 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003644}
3645
Artur Pilipenkocca80022015-10-09 17:41:29 +00003646void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3647 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3648 "apply only to pointer types", &I);
3649 Assert(isa<LoadInst>(I),
3650 "dereferenceable, dereferenceable_or_null apply only to load"
3651 " instructions, use attributes for calls or invokes", &I);
3652 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3653 "take one operand!", &I);
3654 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3655 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3656 "dereferenceable_or_null metadata value must be an i64!", &I);
3657}
3658
Misha Brukmanc566ca362004-03-02 00:22:19 +00003659/// verifyInstruction - Verify that an instruction is well formed.
3660///
Chris Lattner069a7952002-06-25 15:56:27 +00003661void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003662 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003663 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003664
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003665 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003666 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003667 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3668 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003669 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003670 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003671
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003672 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003673 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3674 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003675
Chris Lattner5f126b72004-03-29 00:29:36 +00003676 // Check that the return value of the instruction is either void or a legal
3677 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003678 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3679 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003680
Nick Lewycky93e06a52009-09-27 23:27:42 +00003681 // Check that the instruction doesn't produce metadata. Calls are already
3682 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003683 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3684 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003685
Chris Lattner0e851da2002-04-18 20:37:37 +00003686 // Check that all uses of the instruction, if they are instructions
3687 // themselves, actually have parent basic blocks. If the use is not an
3688 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003689 for (Use &U : I.uses()) {
3690 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003691 Assert(Used->getParent() != nullptr,
3692 "Instruction referencing"
3693 " instruction not embedded in a basic block!",
3694 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003695 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003696 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003697 return;
3698 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003699 }
3700
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003701 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003702 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003703
3704 // Check to make sure that only first-class-values are operands to
3705 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003706 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00003707 Assert(false, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003708 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003709
Chris Lattner9ece94b2004-03-14 03:23:54 +00003710 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003711 // Check to make sure that the "address of" an intrinsic function is never
3712 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003713 Assert(
Justin Lebar9cbc3012016-07-28 23:58:15 +00003714 !F->isIntrinsic() ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003715 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3716 "Cannot take the address of an intrinsic!", &I);
3717 Assert(
3718 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003719 F->getIntrinsicID() == Intrinsic::donothing ||
David Majnemerf93082e2016-08-04 20:30:07 +00003720 F->getIntrinsicID() == Intrinsic::coro_resume ||
3721 F->getIntrinsicID() == Intrinsic::coro_destroy ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003722 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003723 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3724 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
David Majnemerf93082e2016-08-04 20:30:07 +00003725 "Cannot invoke an intrinsic other than donothing, patchpoint, "
3726 "statepoint, coro_resume or coro_destroy",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003727 &I);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003728 Assert(F->getParent() == &M, "Referencing function in another module!",
3729 &I, &M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003730 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003731 Assert(OpBB->getParent() == BB->getParent(),
3732 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003733 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003734 Assert(OpArg->getParent() == BB->getParent(),
3735 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003736 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003737 Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
3738 &M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003739 } else if (isa<Instruction>(I.getOperand(i))) {
3740 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003741 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003742 Assert((i + 1 == e && isa<CallInst>(I)) ||
3743 (i + 3 == e && isa<InvokeInst>(I)),
3744 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003745 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003746 if (CE->getType()->isPtrOrPtrVectorTy() ||
3747 !DL.getNonIntegralAddressSpaces().empty()) {
Matt Arsenault24b49c42013-07-31 17:49:08 +00003748 // If we have a ConstantExpr pointer, we need to see if it came from an
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003749 // illegal bitcast. If the datalayout string specifies non-integral
3750 // address spaces then we also need to check for illegal ptrtoint and
3751 // inttoptr expressions.
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003752 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003753 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003754 }
3755 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003756
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003757 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003758 Assert(I.getType()->isFPOrFPVectorTy(),
3759 "fpmath requires a floating point result!", &I);
3760 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003761 if (ConstantFP *CFP0 =
3762 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003763 const APFloat &Accuracy = CFP0->getValueAPF();
Matt Arsenault82f41512016-06-27 19:43:15 +00003764 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle,
3765 "fpmath accuracy must have float type", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003766 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3767 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003768 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003769 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003770 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003771 }
3772
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003773 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003774 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3775 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003776 visitRangeMetadata(I, Range, I.getType());
3777 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003778
Philip Reames0ca58b32014-10-21 20:56:29 +00003779 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003780 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3781 &I);
3782 Assert(isa<LoadInst>(I),
3783 "nonnull applies only to load instructions, use attributes"
3784 " for calls or invokes",
3785 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003786 }
3787
Artur Pilipenkocca80022015-10-09 17:41:29 +00003788 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3789 visitDereferenceableMetadata(I, MD);
3790
3791 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3792 visitDereferenceableMetadata(I, MD);
3793
3794 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3795 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3796 &I);
3797 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3798 "use attributes for calls or invokes", &I);
3799 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3800 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3801 Assert(CI && CI->getType()->isIntegerTy(64),
3802 "align metadata value must be an i64!", &I);
3803 uint64_t Align = CI->getZExtValue();
3804 Assert(isPowerOf2_64(Align),
3805 "align metadata value must be a power of 2!", &I);
3806 Assert(Align <= Value::MaximumAlignment,
3807 "alignment is larger that implementation defined limit", &I);
3808 }
3809
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003810 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003811 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003812 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003813 }
3814
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003815 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3816 verifyBitPieceExpression(*DII);
3817
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003818 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003819}
3820
Philip Reames007561a2015-06-26 22:21:52 +00003821/// Allow intrinsics to be verified in different ways.
3822void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003823 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003824 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3825 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003826
Chris Lattner144b6192012-05-27 19:37:05 +00003827 // Verify that the intrinsic prototype lines up with what the .td files
3828 // describe.
3829 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003830 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003831
Chris Lattner144b6192012-05-27 19:37:05 +00003832 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3833 getIntrinsicInfoTableEntries(ID, Table);
3834 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003835
Chris Lattner144b6192012-05-27 19:37:05 +00003836 SmallVector<Type *, 4> ArgTys;
Artur Pilipenkobc552272016-06-22 14:56:33 +00003837 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3838 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003839 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003840 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Artur Pilipenkobc552272016-06-22 14:56:33 +00003841 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3842 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003843 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003844
3845 // Verify if the intrinsic call matches the vararg property.
3846 if (IsVarArg)
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003847 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003848 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003849 else
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003850 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003851 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003852
3853 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003854 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003855
3856 // Now that we have the intrinsic ID and the actual argument types (and we
3857 // know they are legal for the intrinsic!) get the intrinsic name through the
3858 // usual means. This allows us to verify the mangling of argument types into
3859 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003860 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003861 Assert(ExpectedName == IF->getName(),
3862 "Intrinsic name not mangled correctly for type arguments! "
3863 "Should be: " +
3864 ExpectedName,
3865 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003866
Chris Lattner588096e2009-12-28 09:07:21 +00003867 // If the intrinsic takes MDNode arguments, verify that they are either global
3868 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003869 for (Value *V : CS.args())
3870 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3871 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003872
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003873 switch (ID) {
3874 default:
3875 break;
Gor Nishanov0f303ac2016-08-12 05:45:49 +00003876 case Intrinsic::coro_id: {
Gor Nishanovdce9b022016-08-29 14:34:12 +00003877 auto *InfoArg = CS.getArgOperand(3)->stripPointerCasts();
Gor Nishanov31d8c9a2016-08-06 02:16:35 +00003878 if (isa<ConstantPointerNull>(InfoArg))
3879 break;
3880 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
3881 Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
3882 "info argument of llvm.coro.begin must refer to an initialized "
3883 "constant");
3884 Constant *Init = GV->getInitializer();
3885 Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
3886 "info argument of llvm.coro.begin must refer to either a struct or "
3887 "an array");
3888 break;
3889 }
Chandler Carruth026cc372011-12-12 04:36:02 +00003890 case Intrinsic::ctlz: // llvm.ctlz
3891 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003892 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003893 "is_zero_undef argument of bit counting intrinsics must be a "
3894 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003895 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003896 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003897 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003898 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3899 "invalid llvm.dbg.declare intrinsic call 1", CS);
3900 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003901 break;
3902 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003903 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003904 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003905 case Intrinsic::memcpy:
3906 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003907 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003908 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003909 Assert(AlignCI,
3910 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003911 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003912 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003913 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003914 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003915 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003916 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003917 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003918 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003919 }
Bill Wendling05604e02008-08-23 09:46:46 +00003920 case Intrinsic::gcroot:
3921 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003922 case Intrinsic::gcread:
3923 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003924 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003925 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3926 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3927 Assert(isa<Constant>(CS.getArgOperand(1)),
3928 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003929 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003930 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003931 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3932 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003933 CS);
Talin2e59f142010-09-30 20:23:47 +00003934 }
Chris Lattner25852062008-08-24 20:46:13 +00003935 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003936
Philip Reames9818dd72015-06-26 22:04:34 +00003937 Assert(CS.getParent()->getParent()->hasGC(),
3938 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003939 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003940 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003941 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003942 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003943 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003944 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003945 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003946 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3947 isa<ConstantInt>(CS.getArgOperand(2)) &&
3948 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3949 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3950 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003951 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003952 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00003953 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3954 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003955 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00003956 case Intrinsic::lifetime_start:
3957 case Intrinsic::lifetime_end:
3958 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00003959 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003960 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00003961 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003962 break;
3963 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00003964 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3965 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003966 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00003967
Reid Kleckner60381792015-07-07 22:25:32 +00003968 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00003969 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003970 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00003971 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003972 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00003973 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00003974 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00003975 if (isa<ConstantPointerNull>(Arg))
3976 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003977 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003978 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00003979 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003980 }
Philip Reames9818dd72015-06-26 22:04:34 +00003981 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003982 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00003983 break;
3984 }
Reid Kleckner60381792015-07-07 22:25:32 +00003985 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00003986 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00003987 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003988 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00003989 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003990 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00003991 CS);
3992 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00003993 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003994 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003995 auto &Entry = FrameEscapeInfo[Fn];
3996 Entry.second = unsigned(
3997 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00003998 break;
3999 }
4000
Philip Reames1ffa9372015-01-30 23:28:05 +00004001 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004002 Assert(!CS.isInlineAsm(),
4003 "gc.statepoint support for inline assembly unimplemented", CS);
4004 Assert(CS.getParent()->getParent()->hasGC(),
4005 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004006
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004007 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004008 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004009 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004010 Assert(CS.getParent()->getParent()->hasGC(),
4011 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004012 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004013 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004014 const Function *StatepointFn =
4015 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004016 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4017 StatepointFn->getIntrinsicID() ==
4018 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004019 "gc.result operand #1 must be from a statepoint", CS,
4020 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004021
Philip Reamesb23713a2014-12-03 22:23:24 +00004022 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004023 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004024 auto *PT = cast<PointerType>(Target->getType());
4025 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004026 Assert(CS.getType() == TargetFuncType->getReturnType(),
4027 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004028 break;
4029 }
4030 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004031 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004032
Philip Reames3e2cf532016-01-07 03:32:11 +00004033 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4034 "gc.relocate must return a pointer or a vector of pointers", CS);
4035
Igor Laevsky9570ff92015-02-19 11:28:47 +00004036 // Check that this relocate is correctly tied to the statepoint
4037
4038 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004039 if (LandingPadInst *LandingPad =
4040 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004041
Sanjoy Das5665c992015-05-11 23:47:27 +00004042 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004043 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004044
4045 // Landingpad relocates should have only one predecessor with invoke
4046 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004047 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004048 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004049 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4050 InvokeBB);
4051 Assert(isStatepoint(InvokeBB->getTerminator()),
4052 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004053 }
4054 else {
4055 // In all other cases relocate should be tied to the statepoint directly.
4056 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004057 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004058 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004059 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004060 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004061 }
4062
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004063 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004064
Manuel Jacob83eefa62016-01-05 04:03:00 +00004065 ImmutableCallSite StatepointCS(
4066 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004067
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004068 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004069 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004070 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004071 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004072
Philip Reames9818dd72015-06-26 22:04:34 +00004073 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004074 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004075 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004076
4077 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4078 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4079 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004080 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004081 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004082 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004083 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004084
4085 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004086 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004087 Assert(StatepointCS.arg_size() > 0,
4088 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004089 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004090 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004091 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004092 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4093 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004094 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004095 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004096 "gc.statepoint: number of transition arguments must be "
4097 "a constant integer");
4098 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004099 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4100 ->getZExtValue();
4101 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004102 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004103 "gc.statepoint: number of deoptimization arguments must be "
4104 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004105 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004106 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4107 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004108 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004109 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004110 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4111 "gc.relocate: statepoint base index doesn't fall within the "
4112 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004113 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004114 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4115 "gc.relocate: statepoint derived index doesn't fall within the "
4116 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004117 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004118
Philip Reames3e2cf532016-01-07 03:32:11 +00004119 // Relocated value must be either a pointer type or vector-of-pointer type,
4120 // but gc_relocate does not need to return the same pointer type as the
4121 // relocated pointer. It can be casted to the correct type later if it's
4122 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004123 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004124 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004125 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004126
Philip Reames3e2cf532016-01-07 03:32:11 +00004127 auto ResultType = CS.getType();
4128 auto DerivedType = Relocate.getDerivedPtr()->getType();
4129 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004130 "gc.relocate: vector relocates to vector and pointer to pointer",
4131 CS);
4132 Assert(
4133 ResultType->getPointerAddressSpace() ==
4134 DerivedType->getPointerAddressSpace(),
4135 "gc.relocate: relocating a pointer shouldn't change its address space",
4136 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004137 break;
4138 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004139 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004140 case Intrinsic::eh_exceptionpointer: {
4141 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4142 "eh.exceptionpointer argument must be a catchpad", CS);
4143 break;
4144 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004145 case Intrinsic::masked_load: {
4146 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4147
4148 Value *Ptr = CS.getArgOperand(0);
4149 //Value *Alignment = CS.getArgOperand(1);
4150 Value *Mask = CS.getArgOperand(2);
4151 Value *PassThru = CS.getArgOperand(3);
4152 Assert(Mask->getType()->isVectorTy(),
4153 "masked_load: mask must be vector", CS);
4154
4155 // DataTy is the overloaded type
4156 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4157 Assert(DataTy == CS.getType(),
4158 "masked_load: return must match pointer type", CS);
4159 Assert(PassThru->getType() == DataTy,
4160 "masked_load: pass through and data type must match", CS);
4161 Assert(Mask->getType()->getVectorNumElements() ==
4162 DataTy->getVectorNumElements(),
4163 "masked_load: vector mask must be same length as data", CS);
4164 break;
4165 }
4166 case Intrinsic::masked_store: {
4167 Value *Val = CS.getArgOperand(0);
4168 Value *Ptr = CS.getArgOperand(1);
4169 //Value *Alignment = CS.getArgOperand(2);
4170 Value *Mask = CS.getArgOperand(3);
4171 Assert(Mask->getType()->isVectorTy(),
4172 "masked_store: mask must be vector", CS);
4173
4174 // DataTy is the overloaded type
4175 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4176 Assert(DataTy == Val->getType(),
4177 "masked_store: storee must match pointer type", CS);
4178 Assert(Mask->getType()->getVectorNumElements() ==
4179 DataTy->getVectorNumElements(),
4180 "masked_store: vector mask must be same length as data", CS);
4181 break;
4182 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004183
Sanjoy Das021de052016-03-31 00:18:46 +00004184 case Intrinsic::experimental_guard: {
4185 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4186 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4187 "experimental_guard must have exactly one "
4188 "\"deopt\" operand bundle");
4189 break;
4190 }
4191
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004192 case Intrinsic::experimental_deoptimize: {
4193 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4194 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4195 "experimental_deoptimize must have exactly one "
4196 "\"deopt\" operand bundle");
4197 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4198 "experimental_deoptimize return type must match caller return type");
4199
4200 if (CS.isCall()) {
4201 auto *DeoptCI = CS.getInstruction();
4202 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4203 Assert(RI,
4204 "calls to experimental_deoptimize must be followed by a return");
4205
4206 if (!CS.getType()->isVoidTy() && RI)
4207 Assert(RI->getReturnValue() == DeoptCI,
4208 "calls to experimental_deoptimize must be followed by a return "
4209 "of the value computed by experimental_deoptimize");
4210 }
4211
4212 break;
4213 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004214 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004215}
4216
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004217/// \brief Carefully grab the subprogram from a local scope.
4218///
4219/// This carefully grabs the subprogram from a local scope, avoiding the
4220/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004221static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004222 if (!LocalScope)
4223 return nullptr;
4224
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004225 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004226 return SP;
4227
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004228 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004229 return getSubprogram(LB->getRawScope());
4230
4231 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004232 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004233 return nullptr;
4234}
4235
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004236template <class DbgIntrinsicTy>
4237void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4238 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004239 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004240 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4241 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004242 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004243 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4244 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004245 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004246 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4247 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004248
4249 // Ignore broken !dbg attachments; they're checked elsewhere.
4250 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004251 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004252 return;
4253
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004254 BasicBlock *BB = DII.getParent();
4255 Function *F = BB ? BB->getParent() : nullptr;
4256
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004257 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004258 DILocalVariable *Var = DII.getVariable();
4259 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004260 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4261 &DII, BB, F);
4262
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004263 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4264 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004265 if (!VarSP || !LocSP)
4266 return; // Broken scope chains are checked elsewhere.
4267
4268 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4269 " variable and !dbg attachment",
4270 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4271 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004272}
4273
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004274static uint64_t getVariableSize(const DILocalVariable &V) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004275 // Be careful of broken types (checked elsewhere).
4276 const Metadata *RawType = V.getRawType();
4277 while (RawType) {
4278 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004279 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004280 if (uint64_t Size = T->getSizeInBits())
4281 return Size;
4282
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004283 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004284 // Look at the base type.
4285 RawType = DT->getRawBaseType();
4286 continue;
4287 }
4288
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004289 // Missing type or size.
4290 break;
4291 }
4292
4293 // Fail gracefully.
4294 return 0;
4295}
4296
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004297void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004298 DILocalVariable *V;
4299 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004300 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004301 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4302 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004303 } else {
4304 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004305 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4306 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004307 }
4308
4309 // We don't know whether this intrinsic verified correctly.
4310 if (!V || !E || !E->isValid())
4311 return;
4312
Keno Fischer253a7bd2016-01-15 02:12:38 +00004313 // Nothing to do if this isn't a bit piece expression.
4314 if (!E->isBitPiece())
4315 return;
4316
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004317 // The frontend helps out GDB by emitting the members of local anonymous
4318 // unions as artificial local variables with shared storage. When SROA splits
4319 // the storage for artificial local variables that are smaller than the entire
4320 // union, the overhang piece will be outside of the allotted space for the
4321 // variable and this check fails.
4322 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4323 if (V->isArtificial())
4324 return;
4325
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004326 // If there's no size, the type is broken, but that should be checked
4327 // elsewhere.
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004328 uint64_t VarSize = getVariableSize(*V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004329 if (!VarSize)
4330 return;
4331
Keno Fischer253a7bd2016-01-15 02:12:38 +00004332 unsigned PieceSize = E->getBitPieceSize();
4333 unsigned PieceOffset = E->getBitPieceOffset();
4334 Assert(PieceSize + PieceOffset <= VarSize,
4335 "piece is larger than or outside of variable", &I, V, E);
4336 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004337}
4338
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004339void Verifier::verifyCompileUnits() {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004340 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004341 SmallPtrSet<const Metadata *, 2> Listed;
4342 if (CUs)
4343 Listed.insert(CUs->op_begin(), CUs->op_end());
4344 Assert(
David Majnemer0a16c222016-08-11 21:15:00 +00004345 all_of(CUVisited,
4346 [&Listed](const Metadata *CU) { return Listed.count(CU); }),
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004347 "All DICompileUnits must be listed in llvm.dbg.cu");
4348 CUVisited.clear();
4349}
4350
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004351void Verifier::verifyDeoptimizeCallingConvs() {
4352 if (DeoptimizeDeclarations.empty())
4353 return;
4354
4355 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004356 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004357 Assert(First->getCallingConv() == F->getCallingConv(),
4358 "All llvm.experimental.deoptimize declarations must have the same "
4359 "calling convention",
4360 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004361 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004362}
4363
Chris Lattner0e851da2002-04-18 20:37:37 +00004364//===----------------------------------------------------------------------===//
4365// Implement the public interfaces to this file...
4366//===----------------------------------------------------------------------===//
4367
Chandler Carruth043949d2014-01-19 02:22:18 +00004368bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004369 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004370
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004371 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004372 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
Chandler Carruth043949d2014-01-19 02:22:18 +00004373
4374 // Note that this function's return value is inverted from what you would
4375 // expect of a function called "verify".
4376 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004377}
4378
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004379bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4380 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004381 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004382 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004383
Chandler Carruth043949d2014-01-19 02:22:18 +00004384 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004385 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004386 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004387
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004388 Broken |= !V.verify();
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004389 if (BrokenDebugInfo)
4390 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004391 // Note that this function's return value is inverted from what you would
4392 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004393 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004394}
Chandler Carruth043949d2014-01-19 02:22:18 +00004395
4396namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004397
Chandler Carruth4d356312014-01-20 11:34:08 +00004398struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004399 static char ID;
4400
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004401 std::unique_ptr<Verifier> V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004402 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004403
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004404 VerifierLegacyPass() : FunctionPass(ID) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004405 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004406 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004407 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004408 : FunctionPass(ID),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004409 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004410 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004411 }
4412
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004413 bool doInitialization(Module &M) override {
4414 V = llvm::make_unique<Verifier>(
4415 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
4416 return false;
4417 }
4418
Craig Topperf398d7c2014-03-05 06:35:38 +00004419 bool runOnFunction(Function &F) override {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004420 if (!V->verify(F) && FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004421 report_fatal_error("Broken function found, compilation aborted!");
4422
4423 return false;
4424 }
4425
Craig Topperf398d7c2014-03-05 06:35:38 +00004426 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004427 bool HasErrors = false;
4428 for (Function &F : M)
4429 if (F.isDeclaration())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004430 HasErrors |= !V->verify(F);
Peter Collingbournebb738172016-06-06 23:21:27 +00004431
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004432 HasErrors |= !V->verify();
Adrian Prantl94a903e2016-05-25 21:33:20 +00004433 if (FatalErrors) {
4434 if (HasErrors)
4435 report_fatal_error("Broken module found, compilation aborted!");
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004436 assert(!V->hasBrokenDebugInfo() && "Module contains invalid debug info");
Adrian Prantl94a903e2016-05-25 21:33:20 +00004437 }
Chandler Carruth043949d2014-01-19 02:22:18 +00004438
Adrian Prantl94a903e2016-05-25 21:33:20 +00004439 // Strip broken debug info.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004440 if (V->hasBrokenDebugInfo()) {
Adrian Prantl94a903e2016-05-25 21:33:20 +00004441 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4442 M.getContext().diagnose(DiagInvalid);
4443 if (!StripDebugInfo(M))
4444 report_fatal_error("Failed to strip malformed debug info");
4445 }
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004446 return false;
4447 }
4448
4449 void getAnalysisUsage(AnalysisUsage &AU) const override {
4450 AU.setPreservesAll();
4451 }
4452};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004453
4454} // end anonymous namespace
Chandler Carruth043949d2014-01-19 02:22:18 +00004455
Chandler Carruth4d356312014-01-20 11:34:08 +00004456char VerifierLegacyPass::ID = 0;
4457INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004458
4459FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004460 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004461}
4462
Adrian Prantle3656182016-05-09 19:57:29 +00004463char VerifierAnalysis::PassID;
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004464VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
4465 ModuleAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004466 Result Res;
4467 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4468 return Res;
4469}
Chandler Carruth4d356312014-01-20 11:34:08 +00004470
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004471VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
4472 FunctionAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004473 return { llvm::verifyFunction(F, &dbgs()), false };
4474}
4475
4476PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4477 auto Res = AM.getResult<VerifierAnalysis>(M);
4478 if (FatalErrors) {
4479 if (Res.IRBroken)
4480 report_fatal_error("Broken module found, compilation aborted!");
4481 assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4482 }
4483
4484 // Strip broken debug info.
4485 if (Res.DebugInfoBroken) {
4486 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4487 M.getContext().diagnose(DiagInvalid);
4488 if (!StripDebugInfo(M))
4489 report_fatal_error("Failed to strip malformed debug info");
4490 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004491 return PreservedAnalyses::all();
4492}
4493
Adrian Prantle3656182016-05-09 19:57:29 +00004494PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4495 auto res = AM.getResult<VerifierAnalysis>(F);
4496 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004497 report_fatal_error("Broken function found, compilation aborted!");
4498
4499 return PreservedAnalyses::all();
4500}