blob: 7eea5170b946f9a6ba49186e1bb72f037d31399e [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) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000701 // There used to be various other llvm.dbg.* nodes, but we don't support
702 // upgrading them and we want to reserve the namespace for future uses.
703 if (NMD.getName().startswith("llvm.dbg."))
704 AssertDI(NMD.getName() == "llvm.dbg.cu",
705 "unrecognized named metadata node in the llvm.dbg namespace",
706 &NMD);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000707 for (const MDNode *MD : NMD.operands()) {
Adrian Prantlb3510af2016-10-05 22:15:37 +0000708 if (NMD.getName() == "llvm.dbg.cu")
Adrian Prantl541a9c52016-05-06 19:26:47 +0000709 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000710
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000711 if (!MD)
712 continue;
713
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000714 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000715 }
716}
717
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000718void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000719 // Only visit each node once. Metadata can be mutually recursive, so this
720 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000721 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000722 return;
723
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000724 switch (MD.getMetadataID()) {
725 default:
726 llvm_unreachable("Invalid MDNode subclass");
727 case Metadata::MDTupleKind:
728 break;
729#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
730 case Metadata::CLASS##Kind: \
731 visit##CLASS(cast<CLASS>(MD)); \
732 break;
733#include "llvm/IR/Metadata.def"
734 }
735
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000736 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000737 if (!Op)
738 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000739 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
740 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000741 if (auto *N = dyn_cast<MDNode>(Op)) {
742 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000743 continue;
744 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000745 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
746 visitValueAsMetadata(*V, nullptr);
747 continue;
748 }
Duncan Sands76d62172010-04-29 16:10:30 +0000749 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000750
751 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000752 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
753 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000754}
755
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000756void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000757 Assert(MD.getValue(), "Expected valid value", &MD);
758 Assert(!MD.getValue()->getType()->isMetadataTy(),
759 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000760
761 auto *L = dyn_cast<LocalAsMetadata>(&MD);
762 if (!L)
763 return;
764
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000765 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000766
767 // If this was an instruction, bb, or argument, verify that it is in the
768 // function that we expect.
769 Function *ActualF = nullptr;
770 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000771 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000772 ActualF = I->getParent()->getParent();
773 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
774 ActualF = BB->getParent();
775 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
776 ActualF = A->getParent();
777 assert(ActualF && "Unimplemented function local metadata case!");
778
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000779 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000780}
781
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000782void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000783 Metadata *MD = MDV.getMetadata();
784 if (auto *N = dyn_cast<MDNode>(MD)) {
785 visitMDNode(*N);
786 return;
787 }
788
789 // Only visit each node once. Metadata can be mutually recursive, so this
790 // avoids infinite recursion here, as well as being an optimization.
791 if (!MDNodes.insert(MD).second)
792 return;
793
794 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
795 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000796}
797
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000798static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
799static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
800static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000801
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000802template <class Ty>
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000803static bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000804 for (Metadata *MD : N.operands()) {
805 if (MD) {
806 if (!isa<Ty>(MD))
807 return false;
808 } else {
809 if (!AllowNull)
810 return false;
811 }
812 }
813 return true;
814}
815
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000816template <class Ty> static bool isValidMetadataArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000817 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
818}
819
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000820template <class Ty> static bool isValidMetadataNullArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000821 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
822}
823
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000824void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000825 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
826 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000827 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000828 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000829}
830
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000831void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000832 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000833}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000834
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000835void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000836 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000837 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000838}
839
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000840void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000841 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
842 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000843}
844
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000845void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000846 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000847}
848
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000849void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000850 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
851 N.getTag() == dwarf::DW_TAG_unspecified_type,
852 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000853}
854
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000855void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000856 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000857 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000858
Adrian Prantl541a9c52016-05-06 19:26:47 +0000859 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
860 N.getTag() == dwarf::DW_TAG_pointer_type ||
861 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
862 N.getTag() == dwarf::DW_TAG_reference_type ||
863 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
864 N.getTag() == dwarf::DW_TAG_const_type ||
865 N.getTag() == dwarf::DW_TAG_volatile_type ||
866 N.getTag() == dwarf::DW_TAG_restrict_type ||
867 N.getTag() == dwarf::DW_TAG_member ||
868 N.getTag() == dwarf::DW_TAG_inheritance ||
869 N.getTag() == dwarf::DW_TAG_friend,
870 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000871 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000872 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
873 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000874 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000875
Adrian Prantl541a9c52016-05-06 19:26:47 +0000876 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
877 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
878 N.getRawBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000879}
880
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000881static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000882 return (Flags & DINode::FlagLValueReference) &&
883 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000884}
885
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000886void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
887 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000888 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000889 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000890 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
891 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000892 }
893}
894
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000895void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000896 // Common scope checks.
897 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000898
Adrian Prantl541a9c52016-05-06 19:26:47 +0000899 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
900 N.getTag() == dwarf::DW_TAG_structure_type ||
901 N.getTag() == dwarf::DW_TAG_union_type ||
902 N.getTag() == dwarf::DW_TAG_enumeration_type ||
903 N.getTag() == dwarf::DW_TAG_class_type,
904 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000905
Adrian Prantl541a9c52016-05-06 19:26:47 +0000906 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
907 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
908 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000909
Adrian Prantl541a9c52016-05-06 19:26:47 +0000910 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
911 "invalid composite elements", &N, N.getRawElements());
912 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
913 N.getRawVTableHolder());
914 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
915 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000916 if (auto *Params = N.getRawTemplateParams())
917 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000918
919 if (N.getTag() == dwarf::DW_TAG_class_type ||
920 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000921 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
922 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000923 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000924}
925
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000926void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000927 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000928 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000929 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000930 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000931 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000932 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000933 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000934 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
935 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000936}
937
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000938void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000939 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000940}
941
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000942void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000943 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
944 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000945
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000946 // Don't bother verifying the compilation directory or producer string
947 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000948 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
949 N.getRawFile());
950 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
951 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000952
Adrian Prantl541a9c52016-05-06 19:26:47 +0000953 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
954 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000955
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000956 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000957 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000958 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000959 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000960 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
961 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000962 }
963 }
964 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000965 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000966 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000967 AssertDI(Op && (isa<DIType>(Op) ||
968 (isa<DISubprogram>(Op) &&
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000969 !cast<DISubprogram>(Op)->isDefinition())),
Adrian Prantl541a9c52016-05-06 19:26:47 +0000970 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000971 }
972 }
973 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000974 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000975 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000976 AssertDI(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref",
977 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000978 }
979 }
980 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000981 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000982 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000983 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
984 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000985 }
986 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000987 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000988 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000989 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000990 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000991 }
992 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000993 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000994}
995
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000996void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000997 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
998 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +0000999 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001000 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001001 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001002 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
1003 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
1004 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001005 if (auto *Params = N.getRawTemplateParams())
1006 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001007 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001008 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1009 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001010 if (auto *RawVars = N.getRawVariables()) {
1011 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001012 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001013 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001014 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
1015 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001016 }
1017 }
Adrian Prantl541a9c52016-05-06 19:26:47 +00001018 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1019 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001020
Adrian Prantl75819ae2016-04-15 15:57:41 +00001021 auto *Unit = N.getRawUnit();
1022 if (N.isDefinition()) {
1023 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001024 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1025 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1026 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001027 } else {
1028 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001029 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001030 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001031}
1032
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001033void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001034 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1035 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1036 "invalid local scope", &N, N.getRawScope());
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001037}
1038
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001039void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1040 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001041
Adrian Prantl541a9c52016-05-06 19:26:47 +00001042 AssertDI(N.getLine() || !N.getColumn(),
1043 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001044}
1045
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001046void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1047 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001048}
1049
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001050void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001051 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001052 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001053 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001054}
1055
Amjad Abouda9bcf162015-12-10 12:56:35 +00001056void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001057 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1058 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1059 "invalid macinfo type", &N);
1060 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001061 if (!N.getValue().empty()) {
1062 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1063 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001064}
1065
1066void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001067 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1068 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001069 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001070 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001071
1072 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001073 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001074 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001075 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001076 }
1077 }
1078}
1079
Adrian Prantlab1243f2015-06-29 23:03:47 +00001080void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001081 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1082 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001083}
1084
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001085void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001086 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001087}
1088
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001089void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1090 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001091
Adrian Prantl541a9c52016-05-06 19:26:47 +00001092 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1093 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001094}
1095
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001096void Verifier::visitDITemplateValueParameter(
1097 const DITemplateValueParameter &N) {
1098 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001099
Adrian Prantl541a9c52016-05-06 19:26:47 +00001100 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1101 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1102 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1103 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001104}
1105
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001106void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001107 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001108 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1109 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001110 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001111 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001112}
1113
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001114void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001115 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001116 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001117
Adrian Prantl541a9c52016-05-06 19:26:47 +00001118 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1119 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Peter Collingbourned4135bb2016-09-13 01:12:59 +00001120 if (auto *V = N.getRawExpr())
1121 AssertDI(isa<DIExpression>(V), "invalid expression location", &N, V);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001122 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001123 AssertDI(isa<DIDerivedType>(Member),
1124 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001125 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001126}
1127
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001128void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001129 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001130 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001131
Adrian Prantl541a9c52016-05-06 19:26:47 +00001132 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1133 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1134 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001135}
1136
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001137void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001138 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001139}
1140
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001141void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001142 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001143 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001144 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001145 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001146 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001147}
1148
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001149void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001150 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1151 N.getTag() == dwarf::DW_TAG_imported_declaration,
1152 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001153 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001154 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1155 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1156 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001157}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001158
David Majnemerdad0a642014-06-27 18:19:56 +00001159void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001160 // The Module is invalid if the GlobalValue has private linkage. Entities
1161 // with private linkage don't have entries in the symbol table.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001162 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001163 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1164 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001165}
1166
Chandler Carruth043949d2014-01-19 02:22:18 +00001167void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001168 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1169 if (!Idents)
1170 return;
1171
1172 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1173 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001174 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001175 Assert(N->getNumOperands() == 1,
1176 "incorrect number of operands in llvm.ident metadata", N);
1177 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1178 ("invalid value for llvm.ident metadata entry operand"
1179 "(the operand should be a string)"),
1180 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001181 }
1182}
1183
Chandler Carruth043949d2014-01-19 02:22:18 +00001184void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001185 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1186 if (!Flags) return;
1187
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001188 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001189 DenseMap<const MDString*, const MDNode*> SeenIDs;
1190 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001191 for (const MDNode *MDN : Flags->operands())
1192 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001193
1194 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001195 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001196 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001197 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001198
Chandler Carruth043949d2014-01-19 02:22:18 +00001199 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001200 if (!Op) {
1201 CheckFailed("invalid requirement on flag, flag is not present in module",
1202 Flag);
1203 continue;
1204 }
1205
1206 if (Op->getOperand(2) != ReqValue) {
1207 CheckFailed(("invalid requirement on flag, "
1208 "flag does not have the required value"),
1209 Flag);
1210 continue;
1211 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001212 }
1213}
1214
Chandler Carruth043949d2014-01-19 02:22:18 +00001215void
1216Verifier::visitModuleFlag(const MDNode *Op,
1217 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1218 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001219 // Each module flag should have three arguments, the merge behavior (a
1220 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001221 Assert(Op->getNumOperands() == 3,
1222 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001223 Module::ModFlagBehavior MFB;
1224 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001225 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001226 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001227 "invalid behavior operand in module flag (expected constant integer)",
1228 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001229 Assert(false,
1230 "invalid behavior operand in module flag (unexpected constant)",
1231 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001232 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001233 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001234 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1235 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001236
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001237 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001238 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001239 case Module::Error:
1240 case Module::Warning:
1241 case Module::Override:
1242 // These behavior types accept any value.
1243 break;
1244
1245 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001246 // The value should itself be an MDNode with two operands, a flag ID (an
1247 // MDString), and a value.
1248 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001249 Assert(Value && Value->getNumOperands() == 2,
1250 "invalid value for 'require' module flag (expected metadata pair)",
1251 Op->getOperand(2));
1252 Assert(isa<MDString>(Value->getOperand(0)),
1253 ("invalid value for 'require' module flag "
1254 "(first value operand should be a string)"),
1255 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001256
1257 // Append it to the list of requirements, to check once all module flags are
1258 // scanned.
1259 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001260 break;
1261 }
1262
1263 case Module::Append:
1264 case Module::AppendUnique: {
1265 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001266 Assert(isa<MDNode>(Op->getOperand(2)),
1267 "invalid value for 'append'-type module flag "
1268 "(expected a metadata node)",
1269 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001270 break;
1271 }
1272 }
1273
1274 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001275 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001276 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001277 Assert(Inserted,
1278 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001279 }
1280}
1281
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001282void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001283 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001284 unsigned Slot = ~0U;
1285 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1286 if (Attrs.getSlotIndex(I) == Idx) {
1287 Slot = I;
1288 break;
1289 }
1290
1291 assert(Slot != ~0U && "Attribute set inconsistency!");
1292
1293 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1294 I != E; ++I) {
1295 if (I->isStringAttribute())
1296 continue;
1297
1298 if (I->getKindAsEnum() == Attribute::NoReturn ||
1299 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001300 I->getKindAsEnum() == Attribute::NoInline ||
1301 I->getKindAsEnum() == Attribute::AlwaysInline ||
1302 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1303 I->getKindAsEnum() == Attribute::StackProtect ||
1304 I->getKindAsEnum() == Attribute::StackProtectReq ||
1305 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001306 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001307 I->getKindAsEnum() == Attribute::NoRedZone ||
1308 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1309 I->getKindAsEnum() == Attribute::Naked ||
1310 I->getKindAsEnum() == Attribute::InlineHint ||
1311 I->getKindAsEnum() == Attribute::StackAlignment ||
1312 I->getKindAsEnum() == Attribute::UWTable ||
1313 I->getKindAsEnum() == Attribute::NonLazyBind ||
1314 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1315 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1316 I->getKindAsEnum() == Attribute::SanitizeThread ||
1317 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1318 I->getKindAsEnum() == Attribute::MinSize ||
1319 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001320 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001321 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001322 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001323 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001324 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001325 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001326 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001327 I->getKindAsEnum() == Attribute::NoRecurse ||
1328 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
George Burgess IV278199f2016-04-12 01:05:35 +00001329 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1330 I->getKindAsEnum() == Attribute::AllocSize) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001331 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001332 CheckFailed("Attribute '" + I->getAsString() +
1333 "' only applies to functions!", V);
1334 return;
1335 }
1336 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001337 I->getKindAsEnum() == Attribute::WriteOnly ||
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001338 I->getKindAsEnum() == Attribute::ReadNone) {
1339 if (Idx == 0) {
1340 CheckFailed("Attribute '" + I->getAsString() +
1341 "' does not apply to function returns");
1342 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001343 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001344 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001345 CheckFailed("Attribute '" + I->getAsString() +
1346 "' does not apply to functions!", V);
1347 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001348 }
1349 }
1350}
1351
Duncan Sandsc3a79922009-06-11 08:11:03 +00001352// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001353// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001354void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001355 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001356 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001357 return;
1358
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001359 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001360
Bill Wendling908126a2012-10-09 09:51:10 +00001361 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001362 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1363 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1364 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1365 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1366 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001367 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001368 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1369 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001370 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001371 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001372 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001373 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001374
Reid Klecknera534a382013-12-19 02:14:12 +00001375 // Check for mutually incompatible attributes. Only inreg is compatible with
1376 // sret.
1377 unsigned AttrCount = 0;
1378 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1379 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1380 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1381 Attrs.hasAttribute(Idx, Attribute::InReg);
1382 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001383 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1384 "and 'sret' are incompatible!",
1385 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001386
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001387 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1388 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1389 "Attributes "
1390 "'inalloca and readonly' are incompatible!",
1391 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001392
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001393 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1394 Attrs.hasAttribute(Idx, Attribute::Returned)),
1395 "Attributes "
1396 "'sret and returned' are incompatible!",
1397 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001398
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001399 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1400 Attrs.hasAttribute(Idx, Attribute::SExt)),
1401 "Attributes "
1402 "'zeroext and signext' are incompatible!",
1403 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001404
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001405 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1406 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1407 "Attributes "
1408 "'readnone and readonly' are incompatible!",
1409 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001410
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001411 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1412 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1413 "Attributes "
1414 "'readnone and writeonly' are incompatible!",
1415 V);
1416
1417 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadOnly) &&
1418 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1419 "Attributes "
1420 "'readonly and writeonly' are incompatible!",
1421 V);
1422
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001423 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1424 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1425 "Attributes "
1426 "'noinline and alwaysinline' are incompatible!",
1427 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001428
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001429 Assert(
1430 !AttrBuilder(Attrs, Idx).overlaps(AttributeFuncs::typeIncompatible(Ty)),
1431 "Wrong types for attribute: " +
1432 AttributeSet::get(Context, Idx, AttributeFuncs::typeIncompatible(Ty))
1433 .getAsString(Idx),
1434 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001435
Reid Klecknera534a382013-12-19 02:14:12 +00001436 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001437 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001438 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001439 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1440 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1441 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1442 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001443 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001444 if (!isa<PointerType>(PTy->getElementType()))
1445 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1446 "Attribute 'swifterror' only applies to parameters "
1447 "with pointer to pointer type!",
1448 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001449 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001450 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1451 "Attribute 'byval' only applies to parameters with pointer type!",
1452 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001453 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1454 "Attribute 'swifterror' only applies to parameters "
1455 "with pointer type!",
1456 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001457 }
Duncan Sands0009c442008-01-12 16:42:01 +00001458}
1459
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001460// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001461// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001462void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001463 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001464 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001465 return;
1466
Duncan Sands8c582282007-12-21 19:19:01 +00001467 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001468 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001469 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001470 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001471 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001472
Chris Lattner8a923e72008-03-12 17:45:29 +00001473 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001474 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001475
Chris Lattner229907c2011-07-18 04:54:35 +00001476 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001477 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001478 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001479 else if (Idx-1 < FT->getNumParams())
1480 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001481 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001482 break; // VarArgs attributes, verified elsewhere.
1483
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001484 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001485
Stephen Linb8bd2322013-04-20 05:14:40 +00001486 if (Idx == 0)
1487 continue;
1488
1489 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001490 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001491 SawNest = true;
1492 }
1493
Stephen Linb8bd2322013-04-20 05:14:40 +00001494 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001495 Assert(!SawReturned, "More than one parameter has attribute returned!",
1496 V);
1497 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1498 "Incompatible "
1499 "argument and return types for 'returned' attribute",
1500 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001501 SawReturned = true;
1502 }
1503
Reid Kleckner79418562014-05-09 22:32:13 +00001504 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001505 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1506 Assert(Idx == 1 || Idx == 2,
1507 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001508 SawSRet = true;
1509 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001510
Manman Renf46262e2016-03-29 17:37:21 +00001511 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1512 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1513 SawSwiftSelf = true;
1514 }
1515
Manman Ren9bfd0d02016-04-01 21:41:15 +00001516 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1517 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1518 V);
1519 SawSwiftError = true;
1520 }
1521
Reid Kleckner60d3a832014-01-16 22:59:24 +00001522 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001523 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1524 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001525 }
Duncan Sands8c582282007-12-21 19:19:01 +00001526 }
Devang Patel9cc98122008-10-01 23:41:25 +00001527
Bill Wendling77543892013-01-18 21:11:39 +00001528 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1529 return;
1530
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001531 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001532
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001533 Assert(
1534 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1535 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1536 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001537
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001538 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001539 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001540 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1541 "Attributes 'readnone and writeonly' are incompatible!", V);
1542
1543 Assert(
1544 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly) &&
1545 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1546 "Attributes 'readonly and writeonly' are incompatible!", V);
1547
1548 Assert(
1549 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001550 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1551 Attribute::InaccessibleMemOrArgMemOnly)),
1552 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1553
1554 Assert(
1555 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1556 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1557 Attribute::InaccessibleMemOnly)),
1558 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1559
1560 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001561 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1562 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1563 Attribute::AlwaysInline)),
1564 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001565
1566 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1567 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001568 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1569 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001570
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001571 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1572 Attribute::OptimizeForSize),
1573 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001574
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001575 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1576 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001577 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001578
1579 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1580 Attribute::JumpTable)) {
1581 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001582 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001583 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001584 }
George Burgess IV278199f2016-04-12 01:05:35 +00001585
1586 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1587 std::pair<unsigned, Optional<unsigned>> Args =
1588 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1589
1590 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1591 if (ParamNo >= FT->getNumParams()) {
1592 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1593 return false;
1594 }
1595
1596 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1597 CheckFailed("'allocsize' " + Name +
1598 " argument must refer to an integer parameter",
1599 V);
1600 return false;
1601 }
1602
1603 return true;
1604 };
1605
1606 if (!CheckParam("element size", Args.first))
1607 return;
1608
1609 if (Args.second && !CheckParam("number of elements", *Args.second))
1610 return;
1611 }
Duncan Sands8c582282007-12-21 19:19:01 +00001612}
1613
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001614void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001615 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001616 for (const auto &Pair : MDs) {
1617 if (Pair.first == LLVMContext::MD_prof) {
1618 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001619 Assert(MD->getNumOperands() == 2,
1620 "!prof annotations should have exactly 2 operands", MD);
1621
1622 // Check first operand.
1623 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1624 MD);
1625 Assert(isa<MDString>(MD->getOperand(0)),
1626 "expected string with name of the !prof annotation", MD);
1627 MDString *MDS = cast<MDString>(MD->getOperand(0));
1628 StringRef ProfName = MDS->getString();
1629 Assert(ProfName.equals("function_entry_count"),
1630 "first operand should be 'function_entry_count'", MD);
1631
1632 // Check second operand.
1633 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1634 MD);
1635 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1636 "expected integer argument to function_entry_count", MD);
1637 }
1638 }
1639}
1640
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001641void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1642 if (!ConstantExprVisited.insert(EntryC).second)
1643 return;
1644
1645 SmallVector<const Constant *, 16> Stack;
1646 Stack.push_back(EntryC);
1647
1648 while (!Stack.empty()) {
1649 const Constant *C = Stack.pop_back_val();
1650
1651 // Check this constant expression.
1652 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1653 visitConstantExpr(CE);
1654
Keno Fischerf6d17b92016-01-14 22:42:02 +00001655 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1656 // Global Values get visited separately, but we do need to make sure
1657 // that the global value is in the correct module
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001658 Assert(GV->getParent() == &M, "Referencing global in another module!",
1659 EntryC, &M, GV, GV->getParent());
Keno Fischerf6d17b92016-01-14 22:42:02 +00001660 continue;
1661 }
1662
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001663 // Visit all sub-expressions.
1664 for (const Use &U : C->operands()) {
1665 const auto *OpC = dyn_cast<Constant>(U);
1666 if (!OpC)
1667 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001668 if (!ConstantExprVisited.insert(OpC).second)
1669 continue;
1670 Stack.push_back(OpC);
1671 }
1672 }
1673}
1674
1675void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001676 if (CE->getOpcode() == Instruction::BitCast)
1677 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1678 CE->getType()),
1679 "Invalid bitcast", CE);
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001680
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001681 if (CE->getOpcode() == Instruction::IntToPtr ||
1682 CE->getOpcode() == Instruction::PtrToInt) {
1683 auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
1684 ? CE->getType()
1685 : CE->getOperand(0)->getType();
1686 StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
1687 ? "inttoptr not supported for non-integral pointers"
1688 : "ptrtoint not supported for non-integral pointers";
1689 Assert(
1690 !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
1691 Msg);
1692 }
Matt Arsenault24b49c42013-07-31 17:49:08 +00001693}
1694
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001695bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001696 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001697 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001698
Devang Patel82fed672008-09-23 22:35:17 +00001699 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001700 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001701 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001702 || (LastIndex == AttributeSet::FunctionIndex
1703 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001704 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001705
Devang Patel82fed672008-09-23 22:35:17 +00001706 return false;
1707}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001708
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001709/// Verify that statepoint intrinsic is well formed.
1710void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001711 assert(CS.getCalledFunction() &&
1712 CS.getCalledFunction()->getIntrinsicID() ==
1713 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001714
Philip Reames0285c742015-02-03 23:18:47 +00001715 const Instruction &CI = *CS.getInstruction();
1716
Igor Laevsky39d662f2015-07-11 10:30:36 +00001717 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1718 !CS.onlyAccessesArgMemory(),
1719 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001720 "reordering restrictions required by safepoint semantics",
1721 &CI);
1722
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001723 const Value *IDV = CS.getArgument(0);
1724 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1725 &CI);
1726
1727 const Value *NumPatchBytesV = CS.getArgument(1);
1728 Assert(isa<ConstantInt>(NumPatchBytesV),
1729 "gc.statepoint number of patchable bytes must be a constant integer",
1730 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001731 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001732 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1733 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1734 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1735 "positive",
1736 &CI);
1737
1738 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001739 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001740 Assert(PT && PT->getElementType()->isFunctionTy(),
1741 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001742 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001743
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001744 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001745 Assert(isa<ConstantInt>(NumCallArgsV),
1746 "gc.statepoint number of arguments to underlying call "
1747 "must be constant integer",
1748 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001749 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001750 Assert(NumCallArgs >= 0,
1751 "gc.statepoint number of arguments to underlying call "
1752 "must be positive",
1753 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001754 const int NumParams = (int)TargetFuncType->getNumParams();
1755 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001756 Assert(NumCallArgs >= NumParams,
1757 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001758
1759 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001760 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1761 "gc.statepoint doesn't support wrapping non-void "
1762 "vararg functions yet",
1763 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001764 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001765 Assert(NumCallArgs == NumParams,
1766 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001767
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001768 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001769 Assert(isa<ConstantInt>(FlagsV),
1770 "gc.statepoint flags must be constant integer", &CI);
1771 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1772 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1773 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001774
1775 // Verify that the types of the call parameter arguments match
1776 // the type of the wrapped callee.
1777 for (int i = 0; i < NumParams; i++) {
1778 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001779 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001780 Assert(ArgType == ParamType,
1781 "gc.statepoint call argument does not match wrapped "
1782 "function type",
1783 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001784 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001785
1786 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001787
1788 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1789 Assert(isa<ConstantInt>(NumTransitionArgsV),
1790 "gc.statepoint number of transition arguments "
1791 "must be constant integer",
1792 &CI);
1793 const int NumTransitionArgs =
1794 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1795 Assert(NumTransitionArgs >= 0,
1796 "gc.statepoint number of transition arguments must be positive", &CI);
1797 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1798
1799 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001800 Assert(isa<ConstantInt>(NumDeoptArgsV),
1801 "gc.statepoint number of deoptimization arguments "
1802 "must be constant integer",
1803 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001804 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001805 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1806 "must be positive",
1807 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001808
Pat Gavlincc0431d2015-05-08 18:07:42 +00001809 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001810 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001811 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001812 "gc.statepoint too few arguments according to length fields", &CI);
1813
Philip Reames1ffa9372015-01-30 23:28:05 +00001814 // Check that the only uses of this gc.statepoint are gc.result or
1815 // gc.relocate calls which are tied to this statepoint and thus part
1816 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001817 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001818 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001819 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001820 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001821 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Sanjoy Das25fb5bd2016-08-11 00:56:46 +00001822 "gc.result or gc.relocate are the only value uses "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001823 "of a gc.statepoint",
1824 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001825 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001826 Assert(Call->getArgOperand(0) == &CI,
1827 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001828 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001829 Assert(Call->getArgOperand(0) == &CI,
1830 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001831 }
1832 }
1833
1834 // Note: It is legal for a single derived pointer to be listed multiple
1835 // times. It's non-optimal, but it is legal. It can also happen after
1836 // insertion if we strip a bitcast away.
1837 // Note: It is really tempting to check that each base is relocated and
1838 // that a derived pointer is never reused as a base pointer. This turns
1839 // out to be problematic since optimizations run after safepoint insertion
1840 // can recognize equality properties that the insertion logic doesn't know
1841 // about. See example statepoint.ll in the verifier subdirectory
1842}
1843
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001844void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001845 for (auto &Counts : FrameEscapeInfo) {
1846 Function *F = Counts.first;
1847 unsigned EscapedObjectCount = Counts.second.first;
1848 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001849 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001850 "all indices passed to llvm.localrecover must be less than the "
1851 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001852 "function",
1853 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001854 }
1855}
1856
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001857static Instruction *getSuccPad(TerminatorInst *Terminator) {
1858 BasicBlock *UnwindDest;
1859 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1860 UnwindDest = II->getUnwindDest();
1861 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1862 UnwindDest = CSI->getUnwindDest();
1863 else
1864 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1865 return UnwindDest->getFirstNonPHI();
1866}
1867
1868void Verifier::verifySiblingFuncletUnwinds() {
1869 SmallPtrSet<Instruction *, 8> Visited;
1870 SmallPtrSet<Instruction *, 8> Active;
1871 for (const auto &Pair : SiblingFuncletInfo) {
1872 Instruction *PredPad = Pair.first;
1873 if (Visited.count(PredPad))
1874 continue;
1875 Active.insert(PredPad);
1876 TerminatorInst *Terminator = Pair.second;
1877 do {
1878 Instruction *SuccPad = getSuccPad(Terminator);
1879 if (Active.count(SuccPad)) {
1880 // Found a cycle; report error
1881 Instruction *CyclePad = SuccPad;
1882 SmallVector<Instruction *, 8> CycleNodes;
1883 do {
1884 CycleNodes.push_back(CyclePad);
1885 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1886 if (CycleTerminator != CyclePad)
1887 CycleNodes.push_back(CycleTerminator);
1888 CyclePad = getSuccPad(CycleTerminator);
1889 } while (CyclePad != SuccPad);
1890 Assert(false, "EH pads can't handle each other's exceptions",
1891 ArrayRef<Instruction *>(CycleNodes));
1892 }
1893 // Don't re-walk a node we've already checked
1894 if (!Visited.insert(SuccPad).second)
1895 break;
1896 // Walk to this successor if it has a map entry.
1897 PredPad = SuccPad;
1898 auto TermI = SiblingFuncletInfo.find(PredPad);
1899 if (TermI == SiblingFuncletInfo.end())
1900 break;
1901 Terminator = TermI->second;
1902 Active.insert(PredPad);
1903 } while (true);
1904 // Each node only has one successor, so we've walked all the active
1905 // nodes' successors.
1906 Active.clear();
1907 }
1908}
1909
Chris Lattner0e851da2002-04-18 20:37:37 +00001910// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001911//
Chandler Carruth043949d2014-01-19 02:22:18 +00001912void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001913 visitGlobalValue(F);
1914
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001915 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001916 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001917 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001918
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001919 Assert(&Context == &F.getContext(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001920 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001921
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001922 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1923 Assert(FT->getNumParams() == NumArgs,
1924 "# formal arguments must match # of arguments for function type!", &F,
1925 FT);
1926 Assert(F.getReturnType()->isFirstClassType() ||
1927 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1928 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001929
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001930 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1931 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001932
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001933 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001934
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001935 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001936 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001937
Duncan Sands8c582282007-12-21 19:19:01 +00001938 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001939 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001940
Michael Gottesman41748d72013-06-27 00:25:01 +00001941 // On function declarations/definitions, we do not support the builtin
1942 // attribute. We do not check this in VerifyFunctionAttrs since that is
1943 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001944 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1945 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001946
Chris Lattneref13ee32006-05-19 21:25:17 +00001947 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001948 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1949 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001950 switch (F.getCallingConv()) {
1951 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001952 case CallingConv::C:
1953 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001954 case CallingConv::Fast:
1955 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001956 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001957 case CallingConv::PTX_Kernel:
1958 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001959 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1960 "perfect forwarding!",
1961 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001962 break;
1963 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001964
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001965 bool isLLVMdotName = F.getName().size() >= 5 &&
1966 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001967
Chris Lattneraf95e582002-04-13 22:48:46 +00001968 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001969 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001970 for (const Argument &Arg : F.args()) {
1971 Assert(Arg.getType() == FT->getParamType(i),
1972 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001973 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001974 Assert(Arg.getType()->isFirstClassType(),
1975 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00001976 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001977 Assert(!Arg.getType()->isMetadataTy(),
1978 "Function takes metadata but isn't an intrinsic", &Arg, &F);
1979 Assert(!Arg.getType()->isTokenTy(),
1980 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001981 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001982
1983 // Check that swifterror argument is only used by loads and stores.
1984 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
1985 verifySwiftErrorValue(&Arg);
1986 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001987 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00001988 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001989
David Majnemerb611e3f2015-08-14 05:09:07 +00001990 if (!isLLVMdotName)
1991 Assert(!F.getReturnType()->isTokenTy(),
1992 "Functions returns a token but isn't an intrinsic", &F);
1993
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001994 // Get the function metadata attachments.
1995 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1996 F.getAllMetadata(MDs);
1997 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001998 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001999
Keno Fischer2ac0c272015-11-16 05:13:30 +00002000 // Check validity of the personality function
2001 if (F.hasPersonalityFn()) {
2002 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
2003 if (Per)
2004 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00002005 "Referencing personality function in another module!",
2006 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00002007 }
2008
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002009 if (F.isMaterializable()) {
2010 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002011 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
2012 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002013 } else if (F.isDeclaration()) {
Peter Collingbourne21521892016-06-21 23:42:48 +00002014 for (const auto &I : MDs) {
2015 AssertDI(I.first != LLVMContext::MD_dbg,
2016 "function declaration may not have a !dbg attachment", &F);
2017 Assert(I.first != LLVMContext::MD_prof,
2018 "function declaration may not have a !prof attachment", &F);
2019
2020 // Verify the metadata itself.
2021 visitMDNode(*I.second);
2022 }
David Majnemer7fddecc2015-06-17 20:52:32 +00002023 Assert(!F.hasPersonalityFn(),
2024 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00002025 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00002026 // Verify that this function (which has a body) is not named "llvm.*". It
2027 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002028 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002029
Chris Lattner149376d2002-10-13 20:57:00 +00002030 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00002031 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002032 Assert(pred_empty(Entry),
2033 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002034
Chris Lattner27471742009-11-01 04:08:01 +00002035 // The address of the entry block cannot be taken, unless it is dead.
2036 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002037 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2038 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00002039 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002040
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002041 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002042 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002043 for (const auto &I : MDs) {
2044 // Verify that the attachment is legal.
2045 switch (I.first) {
2046 default:
2047 break;
2048 case LLVMContext::MD_dbg:
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002049 ++NumDebugAttachments;
2050 AssertDI(NumDebugAttachments == 1,
2051 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002052 AssertDI(isa<DISubprogram>(I.second),
2053 "function !dbg attachment must be a subprogram", &F, I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002054 break;
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002055 case LLVMContext::MD_prof:
2056 ++NumProfAttachments;
2057 Assert(NumProfAttachments == 1,
2058 "function must have a single !prof attachment", &F, I.second);
2059 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002060 }
2061
2062 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002063 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002064 }
Chris Lattner149376d2002-10-13 20:57:00 +00002065 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002066
Chris Lattner7730dcc2009-09-11 17:05:29 +00002067 // If this function is actually an intrinsic, verify that it is only used in
2068 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002069 // Only do this if the module is materialized, otherwise we don't have all the
2070 // uses.
2071 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002072 const User *U;
2073 if (F.hasAddressTaken(&U))
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002074 Assert(false, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002075 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002076
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002077 Assert(!F.hasDLLImportStorageClass() ||
2078 (F.isDeclaration() && F.hasExternalLinkage()) ||
2079 F.hasAvailableExternallyLinkage(),
2080 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002081
2082 auto *N = F.getSubprogram();
2083 if (!N)
2084 return;
2085
Adrian Prantl75819ae2016-04-15 15:57:41 +00002086 visitDISubprogram(*N);
2087
Peter Collingbourned4bff302015-11-05 22:03:56 +00002088 // Check that all !dbg attachments lead to back to N (or, at least, another
2089 // subprogram that describes the same function).
2090 //
2091 // FIXME: Check this incrementally while visiting !dbg attachments.
2092 // FIXME: Only check when N is the canonical subprogram for F.
2093 SmallPtrSet<const MDNode *, 32> Seen;
2094 for (auto &BB : F)
2095 for (auto &I : BB) {
2096 // Be careful about using DILocation here since we might be dealing with
2097 // broken code (this is the Verifier after all).
2098 DILocation *DL =
2099 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2100 if (!DL)
2101 continue;
2102 if (!Seen.insert(DL).second)
2103 continue;
2104
2105 DILocalScope *Scope = DL->getInlinedAtScope();
2106 if (Scope && !Seen.insert(Scope).second)
2107 continue;
2108
2109 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002110
2111 // Scope and SP could be the same MDNode and we don't want to skip
2112 // validation in that case
2113 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002114 continue;
2115
2116 // FIXME: Once N is canonical, check "SP == &N".
Adrian Prantla2ef0472016-09-14 17:30:37 +00002117 AssertDI(SP->describes(&F),
2118 "!dbg attachment points at wrong subprogram for function", N, &F,
2119 &I, DL, Scope, SP);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002120 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002121}
2122
Chris Lattner0e851da2002-04-18 20:37:37 +00002123// verifyBasicBlock - Verify that a basic block is well formed...
2124//
Chris Lattner069a7952002-06-25 15:56:27 +00002125void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002126 InstsInThisBlock.clear();
2127
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002128 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002129 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002130
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002131 // Check constraints that this basic block imposes on all of the PHI nodes in
2132 // it.
2133 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002134 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2135 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002136 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002137 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002138 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002139 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002140 Assert(PN->getNumIncomingValues() != 0,
2141 "PHI nodes must have at least one entry. If the block is dead, "
2142 "the PHI should be removed!",
2143 PN);
2144 Assert(PN->getNumIncomingValues() == Preds.size(),
2145 "PHINode should have one entry for each predecessor of its "
2146 "parent basic block!",
2147 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002148
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002149 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002150 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002151 Values.reserve(PN->getNumIncomingValues());
2152 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2153 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2154 PN->getIncomingValue(i)));
2155 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002156
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002157 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2158 // Check to make sure that if there is more than one entry for a
2159 // particular basic block in this PHI node, that the incoming values are
2160 // all identical.
2161 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002162 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2163 Values[i].second == Values[i - 1].second,
2164 "PHI node has multiple entries for the same basic block with "
2165 "different incoming values!",
2166 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002167
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002168 // Check to make sure that the predecessors and PHI node entries are
2169 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002170 Assert(Values[i].first == Preds[i],
2171 "PHI node entries do not match predecessors!", PN,
2172 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002173 }
2174 }
2175 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002176
2177 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002178 for (auto &I : BB)
2179 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002180 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002181 }
Chris Lattner069a7952002-06-25 15:56:27 +00002182}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002183
Chris Lattner069a7952002-06-25 15:56:27 +00002184void Verifier::visitTerminatorInst(TerminatorInst &I) {
2185 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002186 Assert(&I == I.getParent()->getTerminator(),
2187 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002188 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002189}
2190
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002191void Verifier::visitBranchInst(BranchInst &BI) {
2192 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002193 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2194 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002195 }
2196 visitTerminatorInst(BI);
2197}
2198
Chris Lattner069a7952002-06-25 15:56:27 +00002199void Verifier::visitReturnInst(ReturnInst &RI) {
2200 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002201 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002202 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002203 Assert(N == 0,
2204 "Found return instr that returns non-void in Function of void "
2205 "return type!",
2206 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002207 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002208 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2209 "Function return type does not match operand "
2210 "type of return inst!",
2211 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002212
Misha Brukman7eb05a12003-08-18 14:43:39 +00002213 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002214 // terminators...
2215 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002216}
2217
Chris Lattnerab5aa142004-05-21 16:47:21 +00002218void Verifier::visitSwitchInst(SwitchInst &SI) {
2219 // Check to make sure that all of the constants in the switch instruction
2220 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002221 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002222 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002223 for (auto &Case : SI.cases()) {
2224 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002225 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002226 Assert(Constants.insert(Case.getCaseValue()).second,
2227 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002228 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002229
Chris Lattnerab5aa142004-05-21 16:47:21 +00002230 visitTerminatorInst(SI);
2231}
2232
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002233void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002234 Assert(BI.getAddress()->getType()->isPointerTy(),
2235 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002236 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002237 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2238 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002239
2240 visitTerminatorInst(BI);
2241}
2242
Chris Lattner75648e72004-03-12 05:54:31 +00002243void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002244 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2245 SI.getOperand(2)),
2246 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002247
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002248 Assert(SI.getTrueValue()->getType() == SI.getType(),
2249 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002250 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002251}
2252
Misha Brukmanc566ca362004-03-02 00:22:19 +00002253/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2254/// a pass, if any exist, it's an error.
2255///
Chris Lattner903a25d2002-11-21 16:54:22 +00002256void Verifier::visitUserOp1(Instruction &I) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002257 Assert(false, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002258}
Chris Lattner0e851da2002-04-18 20:37:37 +00002259
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002260void Verifier::visitTruncInst(TruncInst &I) {
2261 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002262 Type *SrcTy = I.getOperand(0)->getType();
2263 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002264
2265 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002266 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2267 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002268
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002269 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2270 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2271 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2272 "trunc source and destination must both be a vector or neither", &I);
2273 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002274
2275 visitInstruction(I);
2276}
2277
2278void Verifier::visitZExtInst(ZExtInst &I) {
2279 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002280 Type *SrcTy = I.getOperand(0)->getType();
2281 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002282
2283 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002284 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2285 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2286 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2287 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002288 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2289 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002290
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002291 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002292
2293 visitInstruction(I);
2294}
2295
2296void Verifier::visitSExtInst(SExtInst &I) {
2297 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002298 Type *SrcTy = I.getOperand(0)->getType();
2299 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002300
2301 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002302 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2303 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002304
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002305 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2306 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2307 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2308 "sext source and destination must both be a vector or neither", &I);
2309 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002310
2311 visitInstruction(I);
2312}
2313
2314void Verifier::visitFPTruncInst(FPTruncInst &I) {
2315 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002316 Type *SrcTy = I.getOperand(0)->getType();
2317 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002318 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002319 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2320 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002321
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002322 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2323 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2324 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2325 "fptrunc source and destination must both be a vector or neither", &I);
2326 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002327
2328 visitInstruction(I);
2329}
2330
2331void Verifier::visitFPExtInst(FPExtInst &I) {
2332 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002333 Type *SrcTy = I.getOperand(0)->getType();
2334 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002335
2336 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002337 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2338 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002339
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002340 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2341 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2342 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2343 "fpext source and destination must both be a vector or neither", &I);
2344 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002345
2346 visitInstruction(I);
2347}
2348
2349void Verifier::visitUIToFPInst(UIToFPInst &I) {
2350 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002351 Type *SrcTy = I.getOperand(0)->getType();
2352 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002353
Duncan Sands19d0b472010-02-16 11:11:14 +00002354 bool SrcVec = SrcTy->isVectorTy();
2355 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002356
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002357 Assert(SrcVec == DstVec,
2358 "UIToFP source and dest must both be vector or scalar", &I);
2359 Assert(SrcTy->isIntOrIntVectorTy(),
2360 "UIToFP source must be integer or integer vector", &I);
2361 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2362 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002363
2364 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002365 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2366 cast<VectorType>(DestTy)->getNumElements(),
2367 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002368
2369 visitInstruction(I);
2370}
2371
2372void Verifier::visitSIToFPInst(SIToFPInst &I) {
2373 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002374 Type *SrcTy = I.getOperand(0)->getType();
2375 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002376
Duncan Sands19d0b472010-02-16 11:11:14 +00002377 bool SrcVec = SrcTy->isVectorTy();
2378 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002379
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002380 Assert(SrcVec == DstVec,
2381 "SIToFP source and dest must both be vector or scalar", &I);
2382 Assert(SrcTy->isIntOrIntVectorTy(),
2383 "SIToFP source must be integer or integer vector", &I);
2384 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2385 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002386
2387 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002388 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2389 cast<VectorType>(DestTy)->getNumElements(),
2390 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002391
2392 visitInstruction(I);
2393}
2394
2395void Verifier::visitFPToUIInst(FPToUIInst &I) {
2396 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002397 Type *SrcTy = I.getOperand(0)->getType();
2398 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002399
Duncan Sands19d0b472010-02-16 11:11:14 +00002400 bool SrcVec = SrcTy->isVectorTy();
2401 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002402
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002403 Assert(SrcVec == DstVec,
2404 "FPToUI source and dest must both be vector or scalar", &I);
2405 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2406 &I);
2407 Assert(DestTy->isIntOrIntVectorTy(),
2408 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002409
2410 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002411 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2412 cast<VectorType>(DestTy)->getNumElements(),
2413 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002414
2415 visitInstruction(I);
2416}
2417
2418void Verifier::visitFPToSIInst(FPToSIInst &I) {
2419 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002420 Type *SrcTy = I.getOperand(0)->getType();
2421 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002422
Duncan Sands19d0b472010-02-16 11:11:14 +00002423 bool SrcVec = SrcTy->isVectorTy();
2424 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002425
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002426 Assert(SrcVec == DstVec,
2427 "FPToSI source and dest must both be vector or scalar", &I);
2428 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2429 &I);
2430 Assert(DestTy->isIntOrIntVectorTy(),
2431 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002432
2433 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002434 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2435 cast<VectorType>(DestTy)->getNumElements(),
2436 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002437
2438 visitInstruction(I);
2439}
2440
2441void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2442 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002443 Type *SrcTy = I.getOperand(0)->getType();
2444 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002445
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002446 Assert(SrcTy->getScalarType()->isPointerTy(),
2447 "PtrToInt source must be pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002448
2449 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002450 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002451 "ptrtoint not supported for non-integral pointers");
2452
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002453 Assert(DestTy->getScalarType()->isIntegerTy(),
2454 "PtrToInt result must be integral", &I);
2455 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2456 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002457
2458 if (SrcTy->isVectorTy()) {
2459 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2460 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002461 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2462 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002463 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002464
2465 visitInstruction(I);
2466}
2467
2468void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2469 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002470 Type *SrcTy = I.getOperand(0)->getType();
2471 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002472
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002473 Assert(SrcTy->getScalarType()->isIntegerTy(),
2474 "IntToPtr source must be an integral", &I);
2475 Assert(DestTy->getScalarType()->isPointerTy(),
2476 "IntToPtr result must be a pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002477
2478 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002479 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002480 "inttoptr not supported for non-integral pointers");
2481
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002482 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2483 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002484 if (SrcTy->isVectorTy()) {
2485 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2486 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002487 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2488 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002489 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002490 visitInstruction(I);
2491}
2492
2493void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002494 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002495 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2496 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002497 visitInstruction(I);
2498}
2499
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002500void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2501 Type *SrcTy = I.getOperand(0)->getType();
2502 Type *DestTy = I.getType();
2503
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002504 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2505 &I);
2506 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2507 &I);
2508 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2509 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002510 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002511 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2512 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002513 visitInstruction(I);
2514}
2515
Misha Brukmanc566ca362004-03-02 00:22:19 +00002516/// visitPHINode - Ensure that a PHI node is well formed.
2517///
Chris Lattner069a7952002-06-25 15:56:27 +00002518void Verifier::visitPHINode(PHINode &PN) {
2519 // Ensure that the PHI nodes are all grouped together at the top of the block.
2520 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002521 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002522 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002523 Assert(&PN == &PN.getParent()->front() ||
2524 isa<PHINode>(--BasicBlock::iterator(&PN)),
2525 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002526
David Majnemerb611e3f2015-08-14 05:09:07 +00002527 // Check that a PHI doesn't yield a Token.
2528 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2529
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002530 // Check that all of the values of the PHI node have the same type as the
2531 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002532 for (Value *IncValue : PN.incoming_values()) {
2533 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002534 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002535 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002536
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002537 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002538
2539 visitInstruction(PN);
2540}
2541
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002542void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002543 Instruction *I = CS.getInstruction();
2544
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002545 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2546 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002547 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002548
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002549 Assert(FPTy->getElementType()->isFunctionTy(),
2550 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002551
2552 Assert(FPTy->getElementType() == CS.getFunctionType(),
2553 "Called function is not the same type as the call!", I);
2554
2555 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002556
2557 // Verify that the correct number of arguments are being passed
2558 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002559 Assert(CS.arg_size() >= FTy->getNumParams(),
2560 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002561 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002562 Assert(CS.arg_size() == FTy->getNumParams(),
2563 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002564
Chris Lattner609de002010-05-10 20:58:42 +00002565 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002566 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002567 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2568 "Call parameter type does not match function signature!",
2569 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002570
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002571 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002572
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002573 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002574 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002575
Duncan Sands8c582282007-12-21 19:19:01 +00002576 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002577 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002578
David Majnemer91db08b2014-04-30 17:22:00 +00002579 // Conservatively check the inalloca argument.
2580 // We have a bug if we can find that there is an underlying alloca without
2581 // inalloca.
2582 if (CS.hasInAllocaArgument()) {
2583 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2584 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002585 Assert(AI->isUsedWithInAlloca(),
2586 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002587 }
2588
Manman Ren9bfd0d02016-04-01 21:41:15 +00002589 // For each argument of the callsite, if it has the swifterror argument,
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002590 // make sure the underlying alloca/parameter it comes from has a swifterror as
2591 // well.
Manman Ren9bfd0d02016-04-01 21:41:15 +00002592 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2593 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2594 Value *SwiftErrorArg = CS.getArgument(i);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002595 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002596 Assert(AI->isSwiftError(),
2597 "swifterror argument for call has mismatched alloca", AI, I);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002598 continue;
2599 }
2600 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
2601 Assert(ArgI, "swifterror argument should come from an alloca or parameter", SwiftErrorArg, I);
2602 Assert(ArgI->hasSwiftErrorAttr(),
2603 "swifterror argument for call has mismatched parameter", ArgI, I);
Manman Ren9bfd0d02016-04-01 21:41:15 +00002604 }
2605
Stephen Linb8bd2322013-04-20 05:14:40 +00002606 if (FTy->isVarArg()) {
2607 // FIXME? is 'nest' even legal here?
2608 bool SawNest = false;
2609 bool SawReturned = false;
2610
2611 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2612 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2613 SawNest = true;
2614 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2615 SawReturned = true;
2616 }
2617
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002618 // Check attributes on the varargs part.
2619 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002620 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002621 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002622
Stephen Linb8bd2322013-04-20 05:14:40 +00002623 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002624 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002625 SawNest = true;
2626 }
2627
2628 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002629 Assert(!SawReturned, "More than one parameter has attribute returned!",
2630 I);
2631 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2632 "Incompatible argument and return types for 'returned' "
2633 "attribute",
2634 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002635 SawReturned = true;
2636 }
Duncan Sands0009c442008-01-12 16:42:01 +00002637
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002638 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2639 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002640
2641 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002642 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002643 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002644 }
Duncan Sands8c582282007-12-21 19:19:01 +00002645
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002646 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002647 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002648 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002649 for (Type *ParamTy : FTy->params()) {
2650 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002651 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002652 Assert(!ParamTy->isTokenTy(),
2653 "Function has token parameter but isn't an intrinsic", I);
2654 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002655 }
2656
David Majnemerb611e3f2015-08-14 05:09:07 +00002657 // Verify that indirect calls don't return tokens.
2658 if (CS.getCalledFunction() == nullptr)
2659 Assert(!FTy->getReturnType()->isTokenTy(),
2660 "Return type cannot be token for indirect call!");
2661
Philip Reamesa3c6f002015-06-26 21:39:44 +00002662 if (Function *F = CS.getCalledFunction())
2663 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002664 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002665
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002666 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2667 // at most one "gc-transition" operand bundle.
2668 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2669 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002670 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002671 OperandBundleUse BU = CS.getOperandBundleAt(i);
2672 uint32_t Tag = BU.getTagID();
2673 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002674 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2675 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002676 } else if (Tag == LLVMContext::OB_gc_transition) {
2677 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2678 I);
2679 FoundGCTransitionBundle = true;
2680 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002681 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2682 FoundFuncletBundle = true;
2683 Assert(BU.Inputs.size() == 1,
2684 "Expected exactly one funclet bundle operand", I);
2685 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2686 "Funclet bundle operands should correspond to a FuncletPadInst",
2687 I);
2688 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002689 }
2690
Adrian Prantl93035c82016-04-24 22:23:13 +00002691 // Verify that each inlinable callsite of a debug-info-bearing function in a
2692 // debug-info-bearing function has a debug location attached to it. Failure to
2693 // do so causes assertion failures when the inliner sets up inline scope info.
2694 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2695 CS.getCalledFunction()->getSubprogram())
2696 Assert(I->getDebugLoc(), "inlinable function call in a function with debug "
2697 "info must have a !dbg location",
2698 I);
2699
Duncan Sands8c582282007-12-21 19:19:01 +00002700 visitInstruction(*I);
2701}
2702
Reid Kleckner5772b772014-04-24 20:14:34 +00002703/// Two types are "congruent" if they are identical, or if they are both pointer
2704/// types with different pointee types and the same address space.
2705static bool isTypeCongruent(Type *L, Type *R) {
2706 if (L == R)
2707 return true;
2708 PointerType *PL = dyn_cast<PointerType>(L);
2709 PointerType *PR = dyn_cast<PointerType>(R);
2710 if (!PL || !PR)
2711 return false;
2712 return PL->getAddressSpace() == PR->getAddressSpace();
2713}
2714
Reid Klecknerd20c9702014-05-15 23:58:57 +00002715static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2716 static const Attribute::AttrKind ABIAttrs[] = {
2717 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002718 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2719 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002720 AttrBuilder Copy;
2721 for (auto AK : ABIAttrs) {
2722 if (Attrs.hasAttribute(I + 1, AK))
2723 Copy.addAttribute(AK);
2724 }
2725 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2726 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2727 return Copy;
2728}
2729
Reid Kleckner5772b772014-04-24 20:14:34 +00002730void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002731 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002732
2733 // - The caller and callee prototypes must match. Pointer types of
2734 // parameters or return types may differ in pointee type, but not
2735 // address space.
2736 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002737 FunctionType *CallerTy = F->getFunctionType();
2738 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002739 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2740 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2741 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2742 "cannot guarantee tail call due to mismatched varargs", &CI);
2743 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2744 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002745 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002746 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002747 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2748 "cannot guarantee tail call due to mismatched parameter types", &CI);
2749 }
2750
2751 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002752 Assert(F->getCallingConv() == CI.getCallingConv(),
2753 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002754
2755 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2756 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002757 AttributeSet CallerAttrs = F->getAttributes();
2758 AttributeSet CalleeAttrs = CI.getAttributes();
2759 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002760 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2761 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002762 Assert(CallerABIAttrs == CalleeABIAttrs,
2763 "cannot guarantee tail call due to mismatched ABI impacting "
2764 "function attributes",
2765 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002766 }
2767
2768 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2769 // or a pointer bitcast followed by a ret instruction.
2770 // - The ret instruction must return the (possibly bitcasted) value
2771 // produced by the call or void.
2772 Value *RetVal = &CI;
2773 Instruction *Next = CI.getNextNode();
2774
2775 // Handle the optional bitcast.
2776 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002777 Assert(BI->getOperand(0) == RetVal,
2778 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002779 RetVal = BI;
2780 Next = BI->getNextNode();
2781 }
2782
2783 // Check the return.
2784 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002785 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2786 &CI);
2787 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2788 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002789}
2790
Duncan Sands8c582282007-12-21 19:19:01 +00002791void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002792 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002793
Reid Kleckner5772b772014-04-24 20:14:34 +00002794 if (CI.isMustTailCall())
2795 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002796}
2797
2798void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002799 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002800
David Majnemer654e1302015-07-31 17:58:14 +00002801 // Verify that the first non-PHI instruction of the unwind destination is an
2802 // exception handling instruction.
2803 Assert(
2804 II.getUnwindDest()->isEHPad(),
2805 "The unwind destination does not have an exception handling instruction!",
2806 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002807
Dan Gohman9c6e1882010-08-02 23:09:14 +00002808 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002809}
Chris Lattner0e851da2002-04-18 20:37:37 +00002810
Misha Brukmanc566ca362004-03-02 00:22:19 +00002811/// visitBinaryOperator - Check that both arguments to the binary operator are
2812/// of the same type!
2813///
Chris Lattner069a7952002-06-25 15:56:27 +00002814void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002815 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2816 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002817
Reid Spencer2341c222007-02-02 02:16:23 +00002818 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002819 // Check that integer arithmetic operators are only used with
2820 // integral operands.
2821 case Instruction::Add:
2822 case Instruction::Sub:
2823 case Instruction::Mul:
2824 case Instruction::SDiv:
2825 case Instruction::UDiv:
2826 case Instruction::SRem:
2827 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002828 Assert(B.getType()->isIntOrIntVectorTy(),
2829 "Integer arithmetic operators only work with integral types!", &B);
2830 Assert(B.getType() == B.getOperand(0)->getType(),
2831 "Integer arithmetic operators must have same type "
2832 "for operands and result!",
2833 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002834 break;
2835 // Check that floating-point arithmetic operators are only used with
2836 // floating-point operands.
2837 case Instruction::FAdd:
2838 case Instruction::FSub:
2839 case Instruction::FMul:
2840 case Instruction::FDiv:
2841 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002842 Assert(B.getType()->isFPOrFPVectorTy(),
2843 "Floating-point arithmetic operators only work with "
2844 "floating-point types!",
2845 &B);
2846 Assert(B.getType() == B.getOperand(0)->getType(),
2847 "Floating-point arithmetic operators must have same type "
2848 "for operands and result!",
2849 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002850 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002851 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002852 case Instruction::And:
2853 case Instruction::Or:
2854 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002855 Assert(B.getType()->isIntOrIntVectorTy(),
2856 "Logical operators only work with integral types!", &B);
2857 Assert(B.getType() == B.getOperand(0)->getType(),
2858 "Logical operators must have same type for operands and result!",
2859 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002860 break;
2861 case Instruction::Shl:
2862 case Instruction::LShr:
2863 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002864 Assert(B.getType()->isIntOrIntVectorTy(),
2865 "Shifts only work with integral types!", &B);
2866 Assert(B.getType() == B.getOperand(0)->getType(),
2867 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002868 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002869 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002870 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002871 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002872
Chris Lattner0e851da2002-04-18 20:37:37 +00002873 visitInstruction(B);
2874}
2875
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002876void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002877 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002878 Type *Op0Ty = IC.getOperand(0)->getType();
2879 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002880 Assert(Op0Ty == Op1Ty,
2881 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002882 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002883 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2884 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002885 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002886 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2887 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2888 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002889
Reid Spencerd9436b62006-11-20 01:22:35 +00002890 visitInstruction(IC);
2891}
2892
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002893void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002894 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002895 Type *Op0Ty = FC.getOperand(0)->getType();
2896 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002897 Assert(Op0Ty == Op1Ty,
2898 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002899 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002900 Assert(Op0Ty->isFPOrFPVectorTy(),
2901 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002902 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002903 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2904 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2905 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002906
Reid Spencerd9436b62006-11-20 01:22:35 +00002907 visitInstruction(FC);
2908}
2909
Robert Bocchino23004482006-01-10 19:05:34 +00002910void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002911 Assert(
2912 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2913 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002914 visitInstruction(EI);
2915}
2916
Robert Bocchinoca27f032006-01-17 20:07:22 +00002917void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002918 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2919 IE.getOperand(2)),
2920 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002921 visitInstruction(IE);
2922}
2923
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002924void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002925 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2926 SV.getOperand(2)),
2927 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002928 visitInstruction(SV);
2929}
2930
Chris Lattner069a7952002-06-25 15:56:27 +00002931void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002932 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002933
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002934 Assert(isa<PointerType>(TargetTy),
2935 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002936 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002937 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002938 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002939 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002940 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002941
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002942 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002943 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002944 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002945
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002946 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002947 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002948 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2949 if (GEP.getPointerOperandType()->isVectorTy())
2950 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2951 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002952 for (Value *Idx : Idxs) {
2953 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002954 if (IndexTy->isVectorTy()) {
2955 unsigned IndexWidth = IndexTy->getVectorNumElements();
2956 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2957 }
2958 Assert(IndexTy->getScalarType()->isIntegerTy(),
2959 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002960 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002961 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002962 visitInstruction(GEP);
2963}
2964
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002965static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2966 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2967}
2968
Philip Reamesbf9676f2014-10-20 23:52:07 +00002969void Verifier::visitRangeMetadata(Instruction& I,
2970 MDNode* Range, Type* Ty) {
2971 assert(Range &&
2972 Range == I.getMetadata(LLVMContext::MD_range) &&
2973 "precondition violation");
2974
2975 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002976 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002977 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002978 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2979
Philip Reamesbf9676f2014-10-20 23:52:07 +00002980 ConstantRange LastRange(1); // Dummy initial value
2981 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002982 ConstantInt *Low =
2983 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002984 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002985 ConstantInt *High =
2986 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002987 Assert(High, "The upper limit must be an integer!", High);
2988 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2989 "Range types must match instruction type!", &I);
2990
Philip Reamesbf9676f2014-10-20 23:52:07 +00002991 APInt HighV = High->getValue();
2992 APInt LowV = Low->getValue();
2993 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002994 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2995 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002996 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002997 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2998 "Intervals are overlapping", Range);
2999 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
3000 Range);
3001 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
3002 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003003 }
3004 LastRange = ConstantRange(LowV, HighV);
3005 }
3006 if (NumRanges > 2) {
3007 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003008 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003009 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003010 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003011 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003012 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
3013 "Intervals are overlapping", Range);
3014 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
3015 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003016 }
3017}
3018
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003019void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
3020 unsigned Size = DL.getTypeSizeInBits(Ty);
JF Bastiend1fb5852015-12-17 22:09:19 +00003021 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
3022 Assert(!(Size & (Size - 1)),
3023 "atomic memory access' operand must have a power-of-two size", Ty, I);
3024}
3025
Chris Lattner069a7952002-06-25 15:56:27 +00003026void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003027 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003028 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00003029 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003030 Assert(LI.getAlignment() <= Value::MaximumAlignment,
3031 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003032 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003033 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003034 Assert(LI.getOrdering() != AtomicOrdering::Release &&
3035 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003036 "Load cannot have Release ordering", &LI);
3037 Assert(LI.getAlignment() != 0,
3038 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003039 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3040 ElTy->isFloatingPointTy(),
3041 "atomic load operand must have integer, pointer, or floating point "
3042 "type!",
3043 ElTy, &LI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003044 checkAtomicMemAccessSize(ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003045 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003046 Assert(LI.getSynchScope() == CrossThread,
3047 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003048 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003049
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003050 visitInstruction(LI);
3051}
3052
Chris Lattner069a7952002-06-25 15:56:27 +00003053void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003054 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003055 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00003056 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003057 Assert(ElTy == SI.getOperand(0)->getType(),
3058 "Stored value type does not match pointer operand type!", &SI, ElTy);
3059 Assert(SI.getAlignment() <= Value::MaximumAlignment,
3060 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003061 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003062 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003063 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3064 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003065 "Store cannot have Acquire ordering", &SI);
3066 Assert(SI.getAlignment() != 0,
3067 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003068 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3069 ElTy->isFloatingPointTy(),
3070 "atomic store operand must have integer, pointer, or floating point "
3071 "type!",
3072 ElTy, &SI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003073 checkAtomicMemAccessSize(ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003074 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003075 Assert(SI.getSynchScope() == CrossThread,
3076 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003077 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003078 visitInstruction(SI);
3079}
3080
Manman Ren9bfd0d02016-04-01 21:41:15 +00003081/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3082void Verifier::verifySwiftErrorCallSite(CallSite CS,
3083 const Value *SwiftErrorVal) {
3084 unsigned Idx = 0;
3085 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3086 I != E; ++I, ++Idx) {
3087 if (*I == SwiftErrorVal) {
3088 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3089 "swifterror value when used in a callsite should be marked "
3090 "with swifterror attribute",
3091 SwiftErrorVal, CS);
3092 }
3093 }
3094}
3095
3096void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3097 // Check that swifterror value is only used by loads, stores, or as
3098 // a swifterror argument.
3099 for (const User *U : SwiftErrorVal->users()) {
3100 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3101 isa<InvokeInst>(U),
3102 "swifterror value can only be loaded and stored from, or "
3103 "as a swifterror argument!",
3104 SwiftErrorVal, U);
3105 // If it is used by a store, check it is the second operand.
3106 if (auto StoreI = dyn_cast<StoreInst>(U))
3107 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3108 "swifterror value should be the second operand when used "
3109 "by stores", SwiftErrorVal, U);
3110 if (auto CallI = dyn_cast<CallInst>(U))
3111 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3112 if (auto II = dyn_cast<InvokeInst>(U))
3113 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3114 }
3115}
3116
Victor Hernandez8acf2952009-10-23 21:09:37 +00003117void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003118 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003119 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003120 Assert(PTy->getAddressSpace() == 0,
3121 "Allocation instruction pointer not in the generic address space!",
3122 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003123 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003124 "Cannot allocate unsized type", &AI);
3125 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3126 "Alloca array size must have integer type", &AI);
3127 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3128 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003129
Manman Ren9bfd0d02016-04-01 21:41:15 +00003130 if (AI.isSwiftError()) {
3131 verifySwiftErrorValue(&AI);
3132 }
3133
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003134 visitInstruction(AI);
3135}
3136
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003137void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003138
3139 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003140 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003141 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003142 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003143 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003144 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003145 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003146 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003147 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003148 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3149 "cmpxchg instructions failure argument shall be no stronger than the "
3150 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003151 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003152 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3153 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003154 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003155
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003156 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003157 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003158 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003159 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3160 "cmpxchg operand must have integer or pointer type",
3161 ElTy, &CXI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003162 checkAtomicMemAccessSize(ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003163 Assert(ElTy == CXI.getOperand(1)->getType(),
3164 "Expected value type does not match pointer operand type!", &CXI,
3165 ElTy);
3166 Assert(ElTy == CXI.getOperand(2)->getType(),
3167 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003168 visitInstruction(CXI);
3169}
3170
3171void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003172 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003173 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003174 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003175 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003176 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003177 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003178 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003179 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3180 &RMWI, ElTy);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003181 checkAtomicMemAccessSize(ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003182 Assert(ElTy == RMWI.getOperand(1)->getType(),
3183 "Argument value type does not match pointer operand type!", &RMWI,
3184 ElTy);
3185 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3186 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3187 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003188 visitInstruction(RMWI);
3189}
3190
Eli Friedmanfee02c62011-07-25 23:16:38 +00003191void Verifier::visitFenceInst(FenceInst &FI) {
3192 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003193 Assert(Ordering == AtomicOrdering::Acquire ||
3194 Ordering == AtomicOrdering::Release ||
3195 Ordering == AtomicOrdering::AcquireRelease ||
3196 Ordering == AtomicOrdering::SequentiallyConsistent,
3197 "fence instructions may only have acquire, release, acq_rel, or "
3198 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003199 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003200 visitInstruction(FI);
3201}
3202
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003203void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003204 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3205 EVI.getIndices()) == EVI.getType(),
3206 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003207
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003208 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003209}
3210
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003211void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003212 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3213 IVI.getIndices()) ==
3214 IVI.getOperand(1)->getType(),
3215 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003216
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003217 visitInstruction(IVI);
3218}
Chris Lattner0e851da2002-04-18 20:37:37 +00003219
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003220static Value *getParentPad(Value *EHPad) {
3221 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3222 return FPI->getParentPad();
3223
3224 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3225}
3226
David Majnemer85a549d2015-08-11 02:48:30 +00003227void Verifier::visitEHPadPredecessors(Instruction &I) {
3228 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003229
David Majnemer85a549d2015-08-11 02:48:30 +00003230 BasicBlock *BB = I.getParent();
3231 Function *F = BB->getParent();
3232
3233 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3234
3235 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3236 // The landingpad instruction defines its parent as a landing pad block. The
3237 // landing pad block may be branched to only by the unwind edge of an
3238 // invoke.
3239 for (BasicBlock *PredBB : predecessors(BB)) {
3240 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3241 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3242 "Block containing LandingPadInst must be jumped to "
3243 "only by the unwind edge of an invoke.",
3244 LPI);
3245 }
3246 return;
3247 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003248 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3249 if (!pred_empty(BB))
3250 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3251 "Block containg CatchPadInst must be jumped to "
3252 "only by its catchswitch.",
3253 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003254 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3255 "Catchswitch cannot unwind to one of its catchpads",
3256 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003257 return;
3258 }
David Majnemer85a549d2015-08-11 02:48:30 +00003259
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003260 // Verify that each pred has a legal terminator with a legal to/from EH
3261 // pad relationship.
3262 Instruction *ToPad = &I;
3263 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003264 for (BasicBlock *PredBB : predecessors(BB)) {
3265 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003266 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003267 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003268 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003269 "EH pad must be jumped to via an unwind edge", ToPad, II);
3270 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3271 FromPad = Bundle->Inputs[0];
3272 else
3273 FromPad = ConstantTokenNone::get(II->getContext());
3274 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003275 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003276 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3277 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3278 FromPad = CSI;
3279 } else {
3280 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3281 }
3282
3283 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003284 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003285 for (;; FromPad = getParentPad(FromPad)) {
3286 Assert(FromPad != ToPad,
3287 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3288 if (FromPad == ToPadParent) {
3289 // This is a legal unwind edge.
3290 break;
3291 }
3292 Assert(!isa<ConstantTokenNone>(FromPad),
3293 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003294 Assert(Seen.insert(FromPad).second,
3295 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003296 }
David Majnemer85a549d2015-08-11 02:48:30 +00003297 }
3298}
3299
3300void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003301 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3302 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003303 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3304 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003305
David Majnemer85a549d2015-08-11 02:48:30 +00003306 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003307
David Majnemer654e1302015-07-31 17:58:14 +00003308 if (!LandingPadResultTy)
3309 LandingPadResultTy = LPI.getType();
3310 else
3311 Assert(LandingPadResultTy == LPI.getType(),
3312 "The landingpad instruction should have a consistent result type "
3313 "inside a function.",
3314 &LPI);
3315
David Majnemer7fddecc2015-06-17 20:52:32 +00003316 Function *F = LPI.getParent()->getParent();
3317 Assert(F->hasPersonalityFn(),
3318 "LandingPadInst needs to be in a function with a personality.", &LPI);
3319
Bill Wendlingfae14752011-08-12 20:24:12 +00003320 // The landingpad instruction must be the first non-PHI instruction in the
3321 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003322 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3323 "LandingPadInst not the first non-PHI instruction in the block.",
3324 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003325
Duncan Sands86de1a62011-09-27 16:43:19 +00003326 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003327 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003328 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003329 Assert(isa<PointerType>(Clause->getType()),
3330 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003331 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003332 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3333 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3334 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003335 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003336 }
3337
Bill Wendlingfae14752011-08-12 20:24:12 +00003338 visitInstruction(LPI);
3339}
3340
David Majnemerba6665d2016-08-01 18:06:34 +00003341void Verifier::visitResumeInst(ResumeInst &RI) {
3342 Assert(RI.getFunction()->hasPersonalityFn(),
3343 "ResumeInst needs to be in a function with a personality.", &RI);
3344
3345 if (!LandingPadResultTy)
3346 LandingPadResultTy = RI.getValue()->getType();
3347 else
3348 Assert(LandingPadResultTy == RI.getValue()->getType(),
3349 "The resume instruction should have a consistent result type "
3350 "inside a function.",
3351 &RI);
3352
3353 visitTerminatorInst(RI);
3354}
3355
David Majnemer654e1302015-07-31 17:58:14 +00003356void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003357 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003358
David Majnemer654e1302015-07-31 17:58:14 +00003359 Function *F = BB->getParent();
3360 Assert(F->hasPersonalityFn(),
3361 "CatchPadInst needs to be in a function with a personality.", &CPI);
3362
David Majnemer8a1c45d2015-12-12 05:38:55 +00003363 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3364 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3365 CPI.getParentPad());
3366
David Majnemer654e1302015-07-31 17:58:14 +00003367 // The catchpad instruction must be the first non-PHI instruction in the
3368 // block.
3369 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003370 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003371
David Majnemerfe2f7f32016-02-29 22:56:36 +00003372 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003373 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003374}
3375
David Majnemer8a1c45d2015-12-12 05:38:55 +00003376void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3377 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3378 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3379 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003380
David Majnemer8a1c45d2015-12-12 05:38:55 +00003381 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003382}
3383
3384void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3385 BasicBlock *BB = CPI.getParent();
3386
David Majnemer654e1302015-07-31 17:58:14 +00003387 Function *F = BB->getParent();
3388 Assert(F->hasPersonalityFn(),
3389 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3390
3391 // The cleanuppad instruction must be the first non-PHI instruction in the
3392 // block.
3393 Assert(BB->getFirstNonPHI() == &CPI,
3394 "CleanupPadInst not the first non-PHI instruction in the block.",
3395 &CPI);
3396
David Majnemer8a1c45d2015-12-12 05:38:55 +00003397 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003398 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003399 "CleanupPadInst has an invalid parent.", &CPI);
3400
David Majnemerfe2f7f32016-02-29 22:56:36 +00003401 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003402 visitFuncletPadInst(CPI);
3403}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003404
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003405void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3406 User *FirstUser = nullptr;
3407 Value *FirstUnwindPad = nullptr;
3408 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003409 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003410
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003411 while (!Worklist.empty()) {
3412 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003413 Assert(Seen.insert(CurrentPad).second,
3414 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003415 Value *UnresolvedAncestorPad = nullptr;
3416 for (User *U : CurrentPad->users()) {
3417 BasicBlock *UnwindDest;
3418 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3419 UnwindDest = CRI->getUnwindDest();
3420 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3421 // We allow catchswitch unwind to caller to nest
3422 // within an outer pad that unwinds somewhere else,
3423 // because catchswitch doesn't have a nounwind variant.
3424 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3425 if (CSI->unwindsToCaller())
3426 continue;
3427 UnwindDest = CSI->getUnwindDest();
3428 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3429 UnwindDest = II->getUnwindDest();
3430 } else if (isa<CallInst>(U)) {
3431 // Calls which don't unwind may be found inside funclet
3432 // pads that unwind somewhere else. We don't *require*
3433 // such calls to be annotated nounwind.
3434 continue;
3435 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3436 // The unwind dest for a cleanup can only be found by
3437 // recursive search. Add it to the worklist, and we'll
3438 // search for its first use that determines where it unwinds.
3439 Worklist.push_back(CPI);
3440 continue;
3441 } else {
3442 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3443 continue;
3444 }
3445
3446 Value *UnwindPad;
3447 bool ExitsFPI;
3448 if (UnwindDest) {
3449 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003450 if (!cast<Instruction>(UnwindPad)->isEHPad())
3451 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003452 Value *UnwindParent = getParentPad(UnwindPad);
3453 // Ignore unwind edges that don't exit CurrentPad.
3454 if (UnwindParent == CurrentPad)
3455 continue;
3456 // Determine whether the original funclet pad is exited,
3457 // and if we are scanning nested pads determine how many
3458 // of them are exited so we can stop searching their
3459 // children.
3460 Value *ExitedPad = CurrentPad;
3461 ExitsFPI = false;
3462 do {
3463 if (ExitedPad == &FPI) {
3464 ExitsFPI = true;
3465 // Now we can resolve any ancestors of CurrentPad up to
3466 // FPI, but not including FPI since we need to make sure
3467 // to check all direct users of FPI for consistency.
3468 UnresolvedAncestorPad = &FPI;
3469 break;
3470 }
3471 Value *ExitedParent = getParentPad(ExitedPad);
3472 if (ExitedParent == UnwindParent) {
3473 // ExitedPad is the ancestor-most pad which this unwind
3474 // edge exits, so we can resolve up to it, meaning that
3475 // ExitedParent is the first ancestor still unresolved.
3476 UnresolvedAncestorPad = ExitedParent;
3477 break;
3478 }
3479 ExitedPad = ExitedParent;
3480 } while (!isa<ConstantTokenNone>(ExitedPad));
3481 } else {
3482 // Unwinding to caller exits all pads.
3483 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3484 ExitsFPI = true;
3485 UnresolvedAncestorPad = &FPI;
3486 }
3487
3488 if (ExitsFPI) {
3489 // This unwind edge exits FPI. Make sure it agrees with other
3490 // such edges.
3491 if (FirstUser) {
3492 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3493 "pad must have the same unwind "
3494 "dest",
3495 &FPI, U, FirstUser);
3496 } else {
3497 FirstUser = U;
3498 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003499 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3500 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3501 getParentPad(UnwindPad) == getParentPad(&FPI))
3502 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003503 }
3504 }
3505 // Make sure we visit all uses of FPI, but for nested pads stop as
3506 // soon as we know where they unwind to.
3507 if (CurrentPad != &FPI)
3508 break;
3509 }
3510 if (UnresolvedAncestorPad) {
3511 if (CurrentPad == UnresolvedAncestorPad) {
3512 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3513 // we've found an unwind edge that exits it, because we need to verify
3514 // all direct uses of FPI.
3515 assert(CurrentPad == &FPI);
3516 continue;
3517 }
3518 // Pop off the worklist any nested pads that we've found an unwind
3519 // destination for. The pads on the worklist are the uncles,
3520 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3521 // for all ancestors of CurrentPad up to but not including
3522 // UnresolvedAncestorPad.
3523 Value *ResolvedPad = CurrentPad;
3524 while (!Worklist.empty()) {
3525 Value *UnclePad = Worklist.back();
3526 Value *AncestorPad = getParentPad(UnclePad);
3527 // Walk ResolvedPad up the ancestor list until we either find the
3528 // uncle's parent or the last resolved ancestor.
3529 while (ResolvedPad != AncestorPad) {
3530 Value *ResolvedParent = getParentPad(ResolvedPad);
3531 if (ResolvedParent == UnresolvedAncestorPad) {
3532 break;
3533 }
3534 ResolvedPad = ResolvedParent;
3535 }
3536 // If the resolved ancestor search didn't find the uncle's parent,
3537 // then the uncle is not yet resolved.
3538 if (ResolvedPad != AncestorPad)
3539 break;
3540 // This uncle is resolved, so pop it from the worklist.
3541 Worklist.pop_back();
3542 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003543 }
3544 }
3545
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003546 if (FirstUnwindPad) {
3547 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3548 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3549 Value *SwitchUnwindPad;
3550 if (SwitchUnwindDest)
3551 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3552 else
3553 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3554 Assert(SwitchUnwindPad == FirstUnwindPad,
3555 "Unwind edges out of a catch must have the same unwind dest as "
3556 "the parent catchswitch",
3557 &FPI, FirstUser, CatchSwitch);
3558 }
3559 }
3560
3561 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003562}
3563
David Majnemer8a1c45d2015-12-12 05:38:55 +00003564void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003565 BasicBlock *BB = CatchSwitch.getParent();
3566
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003567 Function *F = BB->getParent();
3568 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003569 "CatchSwitchInst needs to be in a function with a personality.",
3570 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003571
David Majnemer8a1c45d2015-12-12 05:38:55 +00003572 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003573 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003574 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3575 "CatchSwitchInst not the first non-PHI instruction in the block.",
3576 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003577
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003578 auto *ParentPad = CatchSwitch.getParentPad();
3579 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3580 "CatchSwitchInst has an invalid parent.", ParentPad);
3581
David Majnemer8a1c45d2015-12-12 05:38:55 +00003582 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003583 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003584 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3585 "CatchSwitchInst must unwind to an EH block which is not a "
3586 "landingpad.",
3587 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003588
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003589 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3590 if (getParentPad(I) == ParentPad)
3591 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3592 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003593
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003594 Assert(CatchSwitch.getNumHandlers() != 0,
3595 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3596
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003597 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003598 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3599 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003600 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003601
David Majnemerfe2f7f32016-02-29 22:56:36 +00003602 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003603 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003604}
3605
David Majnemer654e1302015-07-31 17:58:14 +00003606void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003607 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3608 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3609 CRI.getOperand(0));
3610
David Majnemer654e1302015-07-31 17:58:14 +00003611 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3612 Instruction *I = UnwindDest->getFirstNonPHI();
3613 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3614 "CleanupReturnInst must unwind to an EH block which is not a "
3615 "landingpad.",
3616 &CRI);
3617 }
3618
3619 visitTerminatorInst(CRI);
3620}
3621
Rafael Espindola654320a2012-02-26 02:23:37 +00003622void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3623 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003624 // If the we have an invalid invoke, don't try to compute the dominance.
3625 // We already reject it in the invoke specific checks and the dominance
3626 // computation doesn't handle multiple edges.
3627 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3628 if (II->getNormalDest() == II->getUnwindDest())
3629 return;
3630 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003631
Michael Kruseff379b62016-03-26 23:32:57 +00003632 // Quick check whether the def has already been encountered in the same block.
3633 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3634 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003635 //
3636 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3637 // wrapping an SSA value, assert that we've already encountered it. See
3638 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003639 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3640 return;
3641
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003642 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003643 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003644 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003645}
3646
Artur Pilipenkocca80022015-10-09 17:41:29 +00003647void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3648 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3649 "apply only to pointer types", &I);
3650 Assert(isa<LoadInst>(I),
3651 "dereferenceable, dereferenceable_or_null apply only to load"
3652 " instructions, use attributes for calls or invokes", &I);
3653 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3654 "take one operand!", &I);
3655 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3656 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3657 "dereferenceable_or_null metadata value must be an i64!", &I);
3658}
3659
Misha Brukmanc566ca362004-03-02 00:22:19 +00003660/// verifyInstruction - Verify that an instruction is well formed.
3661///
Chris Lattner069a7952002-06-25 15:56:27 +00003662void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003663 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003664 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003665
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003666 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003667 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003668 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3669 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003670 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003671 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003672
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003673 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003674 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3675 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003676
Chris Lattner5f126b72004-03-29 00:29:36 +00003677 // Check that the return value of the instruction is either void or a legal
3678 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003679 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3680 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003681
Nick Lewycky93e06a52009-09-27 23:27:42 +00003682 // Check that the instruction doesn't produce metadata. Calls are already
3683 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003684 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3685 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003686
Chris Lattner0e851da2002-04-18 20:37:37 +00003687 // Check that all uses of the instruction, if they are instructions
3688 // themselves, actually have parent basic blocks. If the use is not an
3689 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003690 for (Use &U : I.uses()) {
3691 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003692 Assert(Used->getParent() != nullptr,
3693 "Instruction referencing"
3694 " instruction not embedded in a basic block!",
3695 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003696 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003697 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003698 return;
3699 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003700 }
3701
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003702 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003703 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003704
3705 // Check to make sure that only first-class-values are operands to
3706 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003707 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00003708 Assert(false, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003709 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003710
Chris Lattner9ece94b2004-03-14 03:23:54 +00003711 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003712 // Check to make sure that the "address of" an intrinsic function is never
3713 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003714 Assert(
Justin Lebar9cbc3012016-07-28 23:58:15 +00003715 !F->isIntrinsic() ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003716 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3717 "Cannot take the address of an intrinsic!", &I);
3718 Assert(
3719 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003720 F->getIntrinsicID() == Intrinsic::donothing ||
David Majnemerf93082e2016-08-04 20:30:07 +00003721 F->getIntrinsicID() == Intrinsic::coro_resume ||
3722 F->getIntrinsicID() == Intrinsic::coro_destroy ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003723 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003724 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3725 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
David Majnemerf93082e2016-08-04 20:30:07 +00003726 "Cannot invoke an intrinsic other than donothing, patchpoint, "
3727 "statepoint, coro_resume or coro_destroy",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003728 &I);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003729 Assert(F->getParent() == &M, "Referencing function in another module!",
3730 &I, &M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003731 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003732 Assert(OpBB->getParent() == BB->getParent(),
3733 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003734 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003735 Assert(OpArg->getParent() == BB->getParent(),
3736 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003737 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003738 Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
3739 &M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003740 } else if (isa<Instruction>(I.getOperand(i))) {
3741 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003742 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003743 Assert((i + 1 == e && isa<CallInst>(I)) ||
3744 (i + 3 == e && isa<InvokeInst>(I)),
3745 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003746 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003747 if (CE->getType()->isPtrOrPtrVectorTy() ||
3748 !DL.getNonIntegralAddressSpaces().empty()) {
Matt Arsenault24b49c42013-07-31 17:49:08 +00003749 // If we have a ConstantExpr pointer, we need to see if it came from an
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003750 // illegal bitcast. If the datalayout string specifies non-integral
3751 // address spaces then we also need to check for illegal ptrtoint and
3752 // inttoptr expressions.
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003753 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003754 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003755 }
3756 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003757
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003758 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003759 Assert(I.getType()->isFPOrFPVectorTy(),
3760 "fpmath requires a floating point result!", &I);
3761 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003762 if (ConstantFP *CFP0 =
3763 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003764 const APFloat &Accuracy = CFP0->getValueAPF();
Matt Arsenault82f41512016-06-27 19:43:15 +00003765 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle,
3766 "fpmath accuracy must have float type", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003767 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3768 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003769 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003770 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003771 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003772 }
3773
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003774 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003775 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3776 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003777 visitRangeMetadata(I, Range, I.getType());
3778 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003779
Philip Reames0ca58b32014-10-21 20:56:29 +00003780 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003781 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3782 &I);
3783 Assert(isa<LoadInst>(I),
3784 "nonnull applies only to load instructions, use attributes"
3785 " for calls or invokes",
3786 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003787 }
3788
Artur Pilipenkocca80022015-10-09 17:41:29 +00003789 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3790 visitDereferenceableMetadata(I, MD);
3791
3792 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3793 visitDereferenceableMetadata(I, MD);
3794
3795 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3796 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3797 &I);
3798 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3799 "use attributes for calls or invokes", &I);
3800 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3801 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3802 Assert(CI && CI->getType()->isIntegerTy(64),
3803 "align metadata value must be an i64!", &I);
3804 uint64_t Align = CI->getZExtValue();
3805 Assert(isPowerOf2_64(Align),
3806 "align metadata value must be a power of 2!", &I);
3807 Assert(Align <= Value::MaximumAlignment,
3808 "alignment is larger that implementation defined limit", &I);
3809 }
3810
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003811 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003812 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003813 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003814 }
3815
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003816 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3817 verifyBitPieceExpression(*DII);
3818
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003819 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003820}
3821
Philip Reames007561a2015-06-26 22:21:52 +00003822/// Allow intrinsics to be verified in different ways.
3823void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003824 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003825 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3826 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003827
Chris Lattner144b6192012-05-27 19:37:05 +00003828 // Verify that the intrinsic prototype lines up with what the .td files
3829 // describe.
3830 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003831 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003832
Chris Lattner144b6192012-05-27 19:37:05 +00003833 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3834 getIntrinsicInfoTableEntries(ID, Table);
3835 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003836
Chris Lattner144b6192012-05-27 19:37:05 +00003837 SmallVector<Type *, 4> ArgTys;
Artur Pilipenkobc552272016-06-22 14:56:33 +00003838 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3839 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003840 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003841 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Artur Pilipenkobc552272016-06-22 14:56:33 +00003842 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3843 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003844 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003845
3846 // Verify if the intrinsic call matches the vararg property.
3847 if (IsVarArg)
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003848 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003849 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003850 else
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003851 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003852 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003853
3854 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003855 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003856
3857 // Now that we have the intrinsic ID and the actual argument types (and we
3858 // know they are legal for the intrinsic!) get the intrinsic name through the
3859 // usual means. This allows us to verify the mangling of argument types into
3860 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003861 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003862 Assert(ExpectedName == IF->getName(),
3863 "Intrinsic name not mangled correctly for type arguments! "
3864 "Should be: " +
3865 ExpectedName,
3866 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003867
Chris Lattner588096e2009-12-28 09:07:21 +00003868 // If the intrinsic takes MDNode arguments, verify that they are either global
3869 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003870 for (Value *V : CS.args())
3871 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3872 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003873
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003874 switch (ID) {
3875 default:
3876 break;
Gor Nishanov0f303ac2016-08-12 05:45:49 +00003877 case Intrinsic::coro_id: {
Gor Nishanovdce9b022016-08-29 14:34:12 +00003878 auto *InfoArg = CS.getArgOperand(3)->stripPointerCasts();
Gor Nishanov31d8c9a2016-08-06 02:16:35 +00003879 if (isa<ConstantPointerNull>(InfoArg))
3880 break;
3881 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
3882 Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
3883 "info argument of llvm.coro.begin must refer to an initialized "
3884 "constant");
3885 Constant *Init = GV->getInitializer();
3886 Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
3887 "info argument of llvm.coro.begin must refer to either a struct or "
3888 "an array");
3889 break;
3890 }
Chandler Carruth026cc372011-12-12 04:36:02 +00003891 case Intrinsic::ctlz: // llvm.ctlz
3892 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003893 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003894 "is_zero_undef argument of bit counting intrinsics must be a "
3895 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003896 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003897 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003898 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003899 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3900 "invalid llvm.dbg.declare intrinsic call 1", CS);
3901 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003902 break;
3903 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003904 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003905 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003906 case Intrinsic::memcpy:
3907 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003908 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003909 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003910 Assert(AlignCI,
3911 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003912 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003913 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003914 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003915 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003916 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003917 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003918 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003919 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003920 }
Bill Wendling05604e02008-08-23 09:46:46 +00003921 case Intrinsic::gcroot:
3922 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003923 case Intrinsic::gcread:
3924 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003925 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003926 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3927 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3928 Assert(isa<Constant>(CS.getArgOperand(1)),
3929 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003930 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003931 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003932 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3933 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003934 CS);
Talin2e59f142010-09-30 20:23:47 +00003935 }
Chris Lattner25852062008-08-24 20:46:13 +00003936 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003937
Philip Reames9818dd72015-06-26 22:04:34 +00003938 Assert(CS.getParent()->getParent()->hasGC(),
3939 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003940 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003941 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003942 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003943 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003944 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003945 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003946 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003947 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3948 isa<ConstantInt>(CS.getArgOperand(2)) &&
3949 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3950 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3951 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003952 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003953 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00003954 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3955 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003956 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00003957 case Intrinsic::lifetime_start:
3958 case Intrinsic::lifetime_end:
3959 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00003960 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003961 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00003962 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003963 break;
3964 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00003965 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3966 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003967 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00003968
Reid Kleckner60381792015-07-07 22:25:32 +00003969 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00003970 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003971 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00003972 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003973 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00003974 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00003975 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00003976 if (isa<ConstantPointerNull>(Arg))
3977 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003978 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003979 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00003980 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003981 }
Philip Reames9818dd72015-06-26 22:04:34 +00003982 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003983 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00003984 break;
3985 }
Reid Kleckner60381792015-07-07 22:25:32 +00003986 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00003987 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00003988 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003989 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00003990 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003991 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00003992 CS);
3993 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00003994 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003995 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003996 auto &Entry = FrameEscapeInfo[Fn];
3997 Entry.second = unsigned(
3998 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00003999 break;
4000 }
4001
Philip Reames1ffa9372015-01-30 23:28:05 +00004002 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00004003 Assert(!CS.isInlineAsm(),
4004 "gc.statepoint support for inline assembly unimplemented", CS);
4005 Assert(CS.getParent()->getParent()->hasGC(),
4006 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004007
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004008 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004009 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004010 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004011 Assert(CS.getParent()->getParent()->hasGC(),
4012 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004013 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004014 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004015 const Function *StatepointFn =
4016 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004017 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4018 StatepointFn->getIntrinsicID() ==
4019 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004020 "gc.result operand #1 must be from a statepoint", CS,
4021 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004022
Philip Reamesb23713a2014-12-03 22:23:24 +00004023 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004024 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004025 auto *PT = cast<PointerType>(Target->getType());
4026 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004027 Assert(CS.getType() == TargetFuncType->getReturnType(),
4028 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004029 break;
4030 }
4031 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004032 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004033
Philip Reames3e2cf532016-01-07 03:32:11 +00004034 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4035 "gc.relocate must return a pointer or a vector of pointers", CS);
4036
Igor Laevsky9570ff92015-02-19 11:28:47 +00004037 // Check that this relocate is correctly tied to the statepoint
4038
4039 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004040 if (LandingPadInst *LandingPad =
4041 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004042
Sanjoy Das5665c992015-05-11 23:47:27 +00004043 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004044 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004045
4046 // Landingpad relocates should have only one predecessor with invoke
4047 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004048 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004049 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004050 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4051 InvokeBB);
4052 Assert(isStatepoint(InvokeBB->getTerminator()),
4053 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004054 }
4055 else {
4056 // In all other cases relocate should be tied to the statepoint directly.
4057 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004058 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004059 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004060 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004061 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004062 }
4063
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004064 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004065
Manuel Jacob83eefa62016-01-05 04:03:00 +00004066 ImmutableCallSite StatepointCS(
4067 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004068
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004069 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004070 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004071 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004072 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004073
Philip Reames9818dd72015-06-26 22:04:34 +00004074 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004075 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004076 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004077
4078 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4079 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4080 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004081 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004082 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004083 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004084 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004085
4086 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004087 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004088 Assert(StatepointCS.arg_size() > 0,
4089 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004090 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004091 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004092 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004093 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4094 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004095 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004096 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004097 "gc.statepoint: number of transition arguments must be "
4098 "a constant integer");
4099 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004100 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4101 ->getZExtValue();
4102 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004103 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004104 "gc.statepoint: number of deoptimization arguments must be "
4105 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004106 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004107 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4108 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004109 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004110 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004111 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4112 "gc.relocate: statepoint base index doesn't fall within the "
4113 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004114 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004115 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4116 "gc.relocate: statepoint derived index doesn't fall within the "
4117 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004118 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004119
Philip Reames3e2cf532016-01-07 03:32:11 +00004120 // Relocated value must be either a pointer type or vector-of-pointer type,
4121 // but gc_relocate does not need to return the same pointer type as the
4122 // relocated pointer. It can be casted to the correct type later if it's
4123 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004124 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004125 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004126 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004127
Philip Reames3e2cf532016-01-07 03:32:11 +00004128 auto ResultType = CS.getType();
4129 auto DerivedType = Relocate.getDerivedPtr()->getType();
4130 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004131 "gc.relocate: vector relocates to vector and pointer to pointer",
4132 CS);
4133 Assert(
4134 ResultType->getPointerAddressSpace() ==
4135 DerivedType->getPointerAddressSpace(),
4136 "gc.relocate: relocating a pointer shouldn't change its address space",
4137 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004138 break;
4139 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004140 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004141 case Intrinsic::eh_exceptionpointer: {
4142 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4143 "eh.exceptionpointer argument must be a catchpad", CS);
4144 break;
4145 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004146 case Intrinsic::masked_load: {
4147 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4148
4149 Value *Ptr = CS.getArgOperand(0);
4150 //Value *Alignment = CS.getArgOperand(1);
4151 Value *Mask = CS.getArgOperand(2);
4152 Value *PassThru = CS.getArgOperand(3);
4153 Assert(Mask->getType()->isVectorTy(),
4154 "masked_load: mask must be vector", CS);
4155
4156 // DataTy is the overloaded type
4157 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4158 Assert(DataTy == CS.getType(),
4159 "masked_load: return must match pointer type", CS);
4160 Assert(PassThru->getType() == DataTy,
4161 "masked_load: pass through and data type must match", CS);
4162 Assert(Mask->getType()->getVectorNumElements() ==
4163 DataTy->getVectorNumElements(),
4164 "masked_load: vector mask must be same length as data", CS);
4165 break;
4166 }
4167 case Intrinsic::masked_store: {
4168 Value *Val = CS.getArgOperand(0);
4169 Value *Ptr = CS.getArgOperand(1);
4170 //Value *Alignment = CS.getArgOperand(2);
4171 Value *Mask = CS.getArgOperand(3);
4172 Assert(Mask->getType()->isVectorTy(),
4173 "masked_store: mask must be vector", CS);
4174
4175 // DataTy is the overloaded type
4176 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4177 Assert(DataTy == Val->getType(),
4178 "masked_store: storee must match pointer type", CS);
4179 Assert(Mask->getType()->getVectorNumElements() ==
4180 DataTy->getVectorNumElements(),
4181 "masked_store: vector mask must be same length as data", CS);
4182 break;
4183 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004184
Sanjoy Das021de052016-03-31 00:18:46 +00004185 case Intrinsic::experimental_guard: {
4186 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4187 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4188 "experimental_guard must have exactly one "
4189 "\"deopt\" operand bundle");
4190 break;
4191 }
4192
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004193 case Intrinsic::experimental_deoptimize: {
4194 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4195 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4196 "experimental_deoptimize must have exactly one "
4197 "\"deopt\" operand bundle");
4198 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4199 "experimental_deoptimize return type must match caller return type");
4200
4201 if (CS.isCall()) {
4202 auto *DeoptCI = CS.getInstruction();
4203 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4204 Assert(RI,
4205 "calls to experimental_deoptimize must be followed by a return");
4206
4207 if (!CS.getType()->isVoidTy() && RI)
4208 Assert(RI->getReturnValue() == DeoptCI,
4209 "calls to experimental_deoptimize must be followed by a return "
4210 "of the value computed by experimental_deoptimize");
4211 }
4212
4213 break;
4214 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004215 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004216}
4217
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004218/// \brief Carefully grab the subprogram from a local scope.
4219///
4220/// This carefully grabs the subprogram from a local scope, avoiding the
4221/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004222static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004223 if (!LocalScope)
4224 return nullptr;
4225
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004226 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004227 return SP;
4228
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004229 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004230 return getSubprogram(LB->getRawScope());
4231
4232 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004233 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004234 return nullptr;
4235}
4236
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004237template <class DbgIntrinsicTy>
4238void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4239 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004240 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004241 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4242 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004243 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004244 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4245 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004246 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004247 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4248 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004249
4250 // Ignore broken !dbg attachments; they're checked elsewhere.
4251 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004252 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004253 return;
4254
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004255 BasicBlock *BB = DII.getParent();
4256 Function *F = BB ? BB->getParent() : nullptr;
4257
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004258 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004259 DILocalVariable *Var = DII.getVariable();
4260 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004261 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4262 &DII, BB, F);
4263
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004264 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4265 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004266 if (!VarSP || !LocSP)
4267 return; // Broken scope chains are checked elsewhere.
4268
Adrian Prantla2ef0472016-09-14 17:30:37 +00004269 AssertDI(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4270 " variable and !dbg attachment",
4271 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4272 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004273}
4274
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004275static uint64_t getVariableSize(const DILocalVariable &V) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004276 // Be careful of broken types (checked elsewhere).
4277 const Metadata *RawType = V.getRawType();
4278 while (RawType) {
4279 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004280 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004281 if (uint64_t Size = T->getSizeInBits())
4282 return Size;
4283
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004284 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004285 // Look at the base type.
4286 RawType = DT->getRawBaseType();
4287 continue;
4288 }
4289
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004290 // Missing type or size.
4291 break;
4292 }
4293
4294 // Fail gracefully.
4295 return 0;
4296}
4297
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004298void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004299 DILocalVariable *V;
4300 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004301 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004302 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4303 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004304 } else {
4305 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004306 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4307 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004308 }
4309
4310 // We don't know whether this intrinsic verified correctly.
4311 if (!V || !E || !E->isValid())
4312 return;
4313
Keno Fischer253a7bd2016-01-15 02:12:38 +00004314 // Nothing to do if this isn't a bit piece expression.
4315 if (!E->isBitPiece())
4316 return;
4317
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004318 // The frontend helps out GDB by emitting the members of local anonymous
4319 // unions as artificial local variables with shared storage. When SROA splits
4320 // the storage for artificial local variables that are smaller than the entire
4321 // union, the overhang piece will be outside of the allotted space for the
4322 // variable and this check fails.
4323 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4324 if (V->isArtificial())
4325 return;
4326
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004327 // If there's no size, the type is broken, but that should be checked
4328 // elsewhere.
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004329 uint64_t VarSize = getVariableSize(*V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004330 if (!VarSize)
4331 return;
4332
Keno Fischer253a7bd2016-01-15 02:12:38 +00004333 unsigned PieceSize = E->getBitPieceSize();
4334 unsigned PieceOffset = E->getBitPieceOffset();
Adrian Prantla2ef0472016-09-14 17:30:37 +00004335 AssertDI(PieceSize + PieceOffset <= VarSize,
Keno Fischer253a7bd2016-01-15 02:12:38 +00004336 "piece is larger than or outside of variable", &I, V, E);
Adrian Prantla2ef0472016-09-14 17:30:37 +00004337 AssertDI(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004338}
4339
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004340void Verifier::verifyCompileUnits() {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004341 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004342 SmallPtrSet<const Metadata *, 2> Listed;
4343 if (CUs)
4344 Listed.insert(CUs->op_begin(), CUs->op_end());
Adrian Prantla2ef0472016-09-14 17:30:37 +00004345 AssertDI(
David Majnemer0a16c222016-08-11 21:15:00 +00004346 all_of(CUVisited,
4347 [&Listed](const Metadata *CU) { return Listed.count(CU); }),
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004348 "All DICompileUnits must be listed in llvm.dbg.cu");
4349 CUVisited.clear();
4350}
4351
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004352void Verifier::verifyDeoptimizeCallingConvs() {
4353 if (DeoptimizeDeclarations.empty())
4354 return;
4355
4356 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004357 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004358 Assert(First->getCallingConv() == F->getCallingConv(),
4359 "All llvm.experimental.deoptimize declarations must have the same "
4360 "calling convention",
4361 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004362 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004363}
4364
Chris Lattner0e851da2002-04-18 20:37:37 +00004365//===----------------------------------------------------------------------===//
4366// Implement the public interfaces to this file...
4367//===----------------------------------------------------------------------===//
4368
Chandler Carruth043949d2014-01-19 02:22:18 +00004369bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004370 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004371
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004372 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004373 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
Chandler Carruth043949d2014-01-19 02:22:18 +00004374
4375 // Note that this function's return value is inverted from what you would
4376 // expect of a function called "verify".
4377 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004378}
4379
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004380bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4381 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004382 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004383 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004384
Chandler Carruth043949d2014-01-19 02:22:18 +00004385 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004386 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004387 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004388
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004389 Broken |= !V.verify();
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004390 if (BrokenDebugInfo)
4391 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004392 // Note that this function's return value is inverted from what you would
4393 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004394 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004395}
Chandler Carruth043949d2014-01-19 02:22:18 +00004396
4397namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004398
Chandler Carruth4d356312014-01-20 11:34:08 +00004399struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004400 static char ID;
4401
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004402 std::unique_ptr<Verifier> V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004403 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004404
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004405 VerifierLegacyPass() : FunctionPass(ID) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004406 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004407 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004408 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004409 : FunctionPass(ID),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004410 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004411 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004412 }
4413
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004414 bool doInitialization(Module &M) override {
4415 V = llvm::make_unique<Verifier>(
4416 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
4417 return false;
4418 }
4419
Craig Topperf398d7c2014-03-05 06:35:38 +00004420 bool runOnFunction(Function &F) override {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004421 if (!V->verify(F) && FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004422 report_fatal_error("Broken function found, compilation aborted!");
4423
4424 return false;
4425 }
4426
Craig Topperf398d7c2014-03-05 06:35:38 +00004427 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004428 bool HasErrors = false;
4429 for (Function &F : M)
4430 if (F.isDeclaration())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004431 HasErrors |= !V->verify(F);
Peter Collingbournebb738172016-06-06 23:21:27 +00004432
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004433 HasErrors |= !V->verify();
Adrian Prantl94a903e2016-05-25 21:33:20 +00004434 if (FatalErrors) {
4435 if (HasErrors)
4436 report_fatal_error("Broken module found, compilation aborted!");
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004437 assert(!V->hasBrokenDebugInfo() && "Module contains invalid debug info");
Adrian Prantl94a903e2016-05-25 21:33:20 +00004438 }
Chandler Carruth043949d2014-01-19 02:22:18 +00004439
Adrian Prantl94a903e2016-05-25 21:33:20 +00004440 // Strip broken debug info.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004441 if (V->hasBrokenDebugInfo()) {
Adrian Prantl94a903e2016-05-25 21:33:20 +00004442 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4443 M.getContext().diagnose(DiagInvalid);
4444 if (!StripDebugInfo(M))
4445 report_fatal_error("Failed to strip malformed debug info");
4446 }
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004447 return false;
4448 }
4449
4450 void getAnalysisUsage(AnalysisUsage &AU) const override {
4451 AU.setPreservesAll();
4452 }
4453};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004454
4455} // end anonymous namespace
Chandler Carruth043949d2014-01-19 02:22:18 +00004456
Chandler Carruth4d356312014-01-20 11:34:08 +00004457char VerifierLegacyPass::ID = 0;
4458INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004459
4460FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004461 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004462}
4463
Adrian Prantle3656182016-05-09 19:57:29 +00004464char VerifierAnalysis::PassID;
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004465VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
4466 ModuleAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004467 Result Res;
4468 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4469 return Res;
4470}
Chandler Carruth4d356312014-01-20 11:34:08 +00004471
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004472VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
4473 FunctionAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004474 return { llvm::verifyFunction(F, &dbgs()), false };
4475}
4476
4477PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4478 auto Res = AM.getResult<VerifierAnalysis>(M);
4479 if (FatalErrors) {
4480 if (Res.IRBroken)
4481 report_fatal_error("Broken module found, compilation aborted!");
4482 assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4483 }
4484
4485 // Strip broken debug info.
4486 if (Res.DebugInfoBroken) {
4487 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4488 M.getContext().diagnose(DiagInvalid);
4489 if (!StripDebugInfo(M))
4490 report_fatal_error("Failed to strip malformed debug info");
4491 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004492 return PreservedAnalyses::all();
4493}
4494
Adrian Prantle3656182016-05-09 19:57:29 +00004495PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4496 auto res = AM.getResult<VerifierAnalysis>(F);
4497 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004498 report_fatal_error("Broken function found, compilation aborted!");
4499
4500 return PreservedAnalyses::all();
4501}