blob: 32ead4f54ad0edcdacddf8af12849f4d7aacd7bb [file] [log] [blame]
Nick Lewyckyd489edf2012-02-25 07:20:06 +00001//===-- Verifier.cpp - Implement the Module Verifier -----------------------==//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner2f7c9632001-06-06 20:29:01 +00009//
Chris Lattner3e6e3e62002-03-29 19:06:18 +000010// This file defines the function verifier interface, that can be used for some
Chris Lattner2f7c9632001-06-06 20:29:01 +000011// sanity checking of input to the system.
12//
Misha Brukman1c9de462004-06-24 21:47:35 +000013// Note that this does not provide full `Java style' security and verifications,
14// instead it just tries to ensure that code is well-formed.
Chris Lattner2f7c9632001-06-06 20:29:01 +000015//
Misha Brukman1c9de462004-06-24 21:47:35 +000016// * Both of a binary operator's parameters are of the same type
Chris Lattnerd46bb6e2002-04-24 19:12:21 +000017// * Verify that the indices of mem access instructions match other operands
Misha Brukman1c9de462004-06-24 21:47:35 +000018// * Verify that arithmetic and other things are only performed on first-class
Chris Lattner8e72d6f2002-08-02 17:37:08 +000019// types. Verify that shifts & logicals only happen on integrals f.e.
Misha Brukman1c9de462004-06-24 21:47:35 +000020// * All of the constants in a switch statement are of the correct type
Chris Lattner8e72d6f2002-08-02 17:37:08 +000021// * The code is in valid SSA form
Misha Brukman1c9de462004-06-24 21:47:35 +000022// * It should be illegal to put a label into any other type (like a structure)
Chris Lattner2f7c9632001-06-06 20:29:01 +000023// or to return one. [except constant arrays!]
Nick Lewyckyf88c84f2008-03-28 06:46:51 +000024// * Only phi nodes can be self referential: 'add i32 %0, %0 ; <int>:0' is bad
Chris Lattnerd02f08d2002-02-20 17:55:43 +000025// * PHI nodes must have an entry for each predecessor, with no extras.
Chris Lattner069a7952002-06-25 15:56:27 +000026// * PHI nodes must be the first thing in a basic block, all grouped together
Chris Lattner4cd9df82002-10-06 21:00:31 +000027// * PHI nodes must have at least one entry
Chris Lattner069a7952002-06-25 15:56:27 +000028// * All basic blocks should only end with terminator insts, not contain them
Chris Lattner3e6e3e62002-03-29 19:06:18 +000029// * The entry node to a function must not have predecessors
Misha Brukmanfa100532003-10-10 17:54:14 +000030// * All Instructions must be embedded into a basic block
Misha Brukman1c9de462004-06-24 21:47:35 +000031// * Functions cannot take a void-typed parameter
Chris Lattneraf95e582002-04-13 22:48:46 +000032// * Verify that a function's argument list agrees with it's declared type.
Chris Lattnerfbf5be52002-03-15 20:25:09 +000033// * It is illegal to specify a name for a void value.
Misha Brukmanfa100532003-10-10 17:54:14 +000034// * It is illegal to have a internal global value with no initializer
Chris Lattner486302a2002-04-12 18:20:49 +000035// * It is illegal to have a ret instruction that returns a value that does not
36// agree with the function return value type.
Chris Lattner338a4622002-05-08 19:49:50 +000037// * Function call argument types match the function prototype
Bill Wendlingfae14752011-08-12 20:24:12 +000038// * A landing pad is defined by a landingpad instruction, and can be jumped to
39// only by the unwind edge of an invoke instruction.
40// * A landingpad instruction must be the first non-PHI instruction in the
41// block.
Vedant Kumar029c3512015-10-21 20:33:31 +000042// * Landingpad instructions must be in a function with a personality function.
Chris Lattnerd46bb6e2002-04-24 19:12:21 +000043// * All other things that are tested by asserts spread about the code...
Chris Lattner2f7c9632001-06-06 20:29:01 +000044//
45//===----------------------------------------------------------------------===//
46
Chandler Carruth5ad5f152014-01-13 09:26:24 +000047#include "llvm/IR/Verifier.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000048#include "llvm/ADT/APFloat.h"
49#include "llvm/ADT/APInt.h"
50#include "llvm/ADT/ArrayRef.h"
51#include "llvm/ADT/DenseMap.h"
52#include "llvm/ADT/ilist.h"
Joseph Tremoulet8ea80862016-01-10 04:31:05 +000053#include "llvm/ADT/MapVector.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000054#include "llvm/ADT/Optional.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000055#include "llvm/ADT/STLExtras.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000056#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000057#include "llvm/ADT/SmallSet.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000058#include "llvm/ADT/SmallVector.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000059#include "llvm/ADT/StringMap.h"
60#include "llvm/ADT/StringRef.h"
61#include "llvm/ADT/Twine.h"
62#include "llvm/IR/Argument.h"
63#include "llvm/IR/Attributes.h"
64#include "llvm/IR/BasicBlock.h"
Chandler Carruth1305dc32014-03-04 11:45:46 +000065#include "llvm/IR/CFG.h"
Chandler Carruth219b89b2014-03-04 11:01:28 +000066#include "llvm/IR/CallSite.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000067#include "llvm/IR/CallingConv.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000068#include "llvm/IR/Comdat.h"
69#include "llvm/IR/Constant.h"
Chandler Carruth8cd041e2014-03-04 12:24:34 +000070#include "llvm/IR/ConstantRange.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000071#include "llvm/IR/Constants.h"
Matt Arsenault24b49c42013-07-31 17:49:08 +000072#include "llvm/IR/DataLayout.h"
Chandler Carruth9a4c9e52014-03-06 00:46:21 +000073#include "llvm/IR/DebugInfo.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000074#include "llvm/IR/DebugInfoMetadata.h"
75#include "llvm/IR/DebugLoc.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000076#include "llvm/IR/DerivedTypes.h"
Adrian Prantle3656182016-05-09 19:57:29 +000077#include "llvm/IR/DiagnosticInfo.h"
Chandler Carruth5ad5f152014-01-13 09:26:24 +000078#include "llvm/IR/Dominators.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000079#include "llvm/IR/Function.h"
80#include "llvm/IR/GlobalAlias.h"
81#include "llvm/IR/GlobalValue.h"
82#include "llvm/IR/GlobalVariable.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000083#include "llvm/IR/InlineAsm.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000084#include "llvm/IR/InstrTypes.h"
85#include "llvm/IR/Instruction.h"
86#include "llvm/IR/Instructions.h"
Chandler Carruth7da14f12014-03-06 03:23:41 +000087#include "llvm/IR/InstVisitor.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000088#include "llvm/IR/IntrinsicInst.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000089#include "llvm/IR/Intrinsics.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000090#include "llvm/IR/LLVMContext.h"
91#include "llvm/IR/Metadata.h"
92#include "llvm/IR/Module.h"
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +000093#include "llvm/IR/ModuleSlotTracker.h"
Chandler Carruth4d356312014-01-20 11:34:08 +000094#include "llvm/IR/PassManager.h"
Philip Reames38303a32014-12-03 19:53:15 +000095#include "llvm/IR/Statepoint.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +000096#include "llvm/IR/Type.h"
97#include "llvm/IR/Use.h"
98#include "llvm/IR/User.h"
99#include "llvm/IR/Value.h"
Chris Lattner8a923e72008-03-12 17:45:29 +0000100#include "llvm/Pass.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000101#include "llvm/Support/AtomicOrdering.h"
102#include "llvm/Support/Casting.h"
Manman Ren74c61b92013-07-19 00:31:03 +0000103#include "llvm/Support/CommandLine.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +0000104#include "llvm/Support/Debug.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000105#include "llvm/Support/Dwarf.h"
Torok Edwin6dd27302009-07-08 18:01:40 +0000106#include "llvm/Support/ErrorHandling.h"
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000107#include "llvm/Support/MathExtras.h"
Chris Lattner24025262009-02-28 21:05:51 +0000108#include "llvm/Support/raw_ostream.h"
Chris Lattnerd02f08d2002-02-20 17:55:43 +0000109#include <algorithm>
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000110#include <cassert>
111#include <cstdint>
112#include <memory>
113#include <string>
114#include <utility>
115
Chris Lattner189d19f2003-11-21 20:23:48 +0000116using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +0000117
Duncan P. N. Exon Smith0633fd72015-03-17 17:28:41 +0000118static cl::opt<bool> VerifyDebugInfo("verify-debug-info", cl::init(true));
Manman Ren74c61b92013-07-19 00:31:03 +0000119
Dan Gohmand78c4002008-05-13 00:00:25 +0000120namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000121
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000122struct VerifierSupport {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000123 raw_ostream *OS;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000124 const Module &M;
125 ModuleSlotTracker MST;
126 const DataLayout &DL;
127 LLVMContext &Context;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000128
Duncan P. N. Exon Smith9c3ff192016-04-20 15:55:24 +0000129 /// Track the brokenness of the module while recursively visiting.
130 bool Broken = false;
Adrian Prantl541a9c52016-05-06 19:26:47 +0000131 /// Broken debug info can be "recovered" from by stripping the debug info.
132 bool BrokenDebugInfo = false;
133 /// Whether to treat broken debug info as an error.
134 bool TreatBrokenDebugInfoAsError = true;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000135
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000136 explicit VerifierSupport(raw_ostream *OS, const Module &M)
137 : OS(OS), M(M), MST(&M), DL(M.getDataLayout()), Context(M.getContext()) {}
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000138
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000139private:
Keno Fischera6c4ce42015-12-01 19:06:36 +0000140 void Write(const Module *M) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000141 *OS << "; ModuleID = '" << M->getModuleIdentifier() << "'\n";
Keno Fischera6c4ce42015-12-01 19:06:36 +0000142 }
143
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000144 void Write(const Value *V) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000145 if (!V)
146 return;
147 if (isa<Instruction>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000148 V->print(*OS, MST);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000149 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000150 } else {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000151 V->printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000152 *OS << '\n';
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000153 }
154 }
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000155
Philip Reames9818dd72015-06-26 22:04:34 +0000156 void Write(ImmutableCallSite CS) {
157 Write(CS.getInstruction());
Philip Reamesa3c6f002015-06-26 21:39:44 +0000158 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000159
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000160 void Write(const Metadata *MD) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000161 if (!MD)
162 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000163 MD->print(*OS, MST, &M);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000164 *OS << '\n';
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000165 }
166
Duncan P. N. Exon Smith11344732015-04-07 16:50:39 +0000167 template <class T> void Write(const MDTupleTypedArrayWrapper<T> &MD) {
168 Write(MD.get());
169 }
170
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000171 void Write(const NamedMDNode *NMD) {
172 if (!NMD)
173 return;
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000174 NMD->print(*OS, MST);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000175 *OS << '\n';
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000176 }
177
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000178 void Write(Type *T) {
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000179 if (!T)
180 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000181 *OS << ' ' << *T;
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000182 }
183
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000184 void Write(const Comdat *C) {
David Majnemerdad0a642014-06-27 18:19:56 +0000185 if (!C)
186 return;
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000187 *OS << *C;
David Majnemerdad0a642014-06-27 18:19:56 +0000188 }
189
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000190 template <typename T> void Write(ArrayRef<T> Vs) {
191 for (const T &V : Vs)
192 Write(V);
193 }
194
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000195 template <typename T1, typename... Ts>
196 void WriteTs(const T1 &V1, const Ts &... Vs) {
197 Write(V1);
198 WriteTs(Vs...);
199 }
200
201 template <typename... Ts> void WriteTs() {}
202
203public:
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000204 /// \brief A check failed, so printout out the condition and the message.
205 ///
206 /// This provides a nice place to put a breakpoint if you want to see why
207 /// something is not correct.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000208 void CheckFailed(const Twine &Message) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000209 if (OS)
210 *OS << Message << '\n';
Duncan P. N. Exon Smith6a607c02015-03-31 02:37:13 +0000211 Broken = true;
David Majnemerdad0a642014-06-27 18:19:56 +0000212 }
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000213
Duncan P. N. Exon Smithf2929c92015-03-16 17:49:03 +0000214 /// \brief A check failed (with values to print).
215 ///
216 /// This calls the Message-only version so that the above is easier to set a
217 /// breakpoint on.
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000218 template <typename T1, typename... Ts>
219 void CheckFailed(const Twine &Message, const T1 &V1, const Ts &... Vs) {
220 CheckFailed(Message);
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +0000221 if (OS)
222 WriteTs(V1, Vs...);
Duncan P. N. Exon Smithec9d3f72015-03-14 16:47:37 +0000223 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000224
225 /// A debug info check failed.
226 void DebugInfoCheckFailed(const Twine &Message) {
227 if (OS)
228 *OS << Message << '\n';
229 Broken |= TreatBrokenDebugInfoAsError;
230 BrokenDebugInfo = true;
231 }
232
233 /// A debug info check failed (with values to print).
234 template <typename T1, typename... Ts>
235 void DebugInfoCheckFailed(const Twine &Message, const T1 &V1,
236 const Ts &... Vs) {
237 DebugInfoCheckFailed(Message);
238 if (OS)
239 WriteTs(V1, Vs...);
240 }
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000241};
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000242
Duncan P. N. Exon Smith67b44da2014-04-15 16:27:32 +0000243class Verifier : public InstVisitor<Verifier>, VerifierSupport {
244 friend class InstVisitor<Verifier>;
245
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000246 DominatorTree DT;
Chris Lattnerc9e79d02004-09-29 20:07:45 +0000247
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000248 /// \brief When verifying a basic block, keep track of all of the
249 /// instructions we have seen so far.
250 ///
251 /// This allows us to do efficient dominance checks for the case when an
252 /// instruction has an operand that is an instruction in the same block.
253 SmallPtrSet<Instruction *, 16> InstsInThisBlock;
Bill Wendlingfae14752011-08-12 20:24:12 +0000254
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000255 /// \brief Keep track of the metadata nodes that have been checked already.
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000256 SmallPtrSet<const Metadata *, 32> MDNodes;
Manman Ren9974c882013-07-23 00:22:51 +0000257
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000258 /// Track all DICompileUnits visited.
259 SmallPtrSet<const Metadata *, 2> CUVisited;
260
David Majnemer654e1302015-07-31 17:58:14 +0000261 /// \brief The result type for a landingpad.
262 Type *LandingPadResultTy;
263
Reid Kleckner60381792015-07-07 22:25:32 +0000264 /// \brief Whether we've seen a call to @llvm.localescape in this function
Reid Klecknere9b89312015-01-13 00:48:10 +0000265 /// already.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000266 bool SawFrameEscape;
267
Reid Kleckner60381792015-07-07 22:25:32 +0000268 /// Stores the count of how many objects were passed to llvm.localescape for a
269 /// given function and the largest index passed to llvm.localrecover.
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000270 DenseMap<Function *, std::pair<unsigned, unsigned>> FrameEscapeInfo;
Reid Klecknere9b89312015-01-13 00:48:10 +0000271
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000272 // Maps catchswitches and cleanuppads that unwind to siblings to the
273 // terminators that indicate the unwind, used to detect cycles therein.
274 MapVector<Instruction *, TerminatorInst *> SiblingFuncletInfo;
275
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000276 /// Cache of constants visited in search of ConstantExprs.
277 SmallPtrSet<const Constant *, 32> ConstantExprVisited;
278
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000279 /// Cache of declarations of the llvm.experimental.deoptimize.<ty> intrinsic.
280 SmallVector<const Function *, 4> DeoptimizeDeclarations;
281
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000282 // Verify that this GlobalValue is only used in this module.
283 // This map is used to avoid visiting uses twice. We can arrive at a user
284 // twice, if they have multiple operands. In particular for very large
285 // constant expressions, we can arrive at a particular user many times.
286 SmallPtrSet<const Value *, 32> GlobalValueVisited;
287
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000288 void checkAtomicMemAccessSize(Type *Ty, const Instruction *I);
Duncan P. N. Exon Smith0ecff952016-04-20 17:27:44 +0000289
Chandler Carruth043949d2014-01-19 02:22:18 +0000290public:
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000291 explicit Verifier(raw_ostream *OS, bool ShouldTreatBrokenDebugInfoAsError,
292 const Module &M)
293 : VerifierSupport(OS, M), LandingPadResultTy(nullptr),
Adrian Prantl541a9c52016-05-06 19:26:47 +0000294 SawFrameEscape(false) {
295 TreatBrokenDebugInfoAsError = ShouldTreatBrokenDebugInfoAsError;
296 }
297
298 bool hasBrokenDebugInfo() const { return BrokenDebugInfo; }
Chris Lattner0e851da2002-04-18 20:37:37 +0000299
Chandler Carruth043949d2014-01-19 02:22:18 +0000300 bool verify(const Function &F) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000301 assert(F.getParent() == &M &&
302 "An instance of this class only works with a specific module!");
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000303
304 // First ensure the function is well-enough formed to compute dominance
Peter Collingbourne71bb7942016-06-06 22:32:52 +0000305 // information, and directly compute a dominance tree. We don't rely on the
306 // pass manager to provide this as it isolates us from a potentially
307 // out-of-date dominator tree and makes it significantly more complex to run
308 // this code outside of a pass manager.
309 // FIXME: It's really gross that we have to cast away constness here.
310 if (!F.empty())
311 DT.recalculate(const_cast<Function &>(F));
312
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000313 for (const BasicBlock &BB : F) {
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000314 if (!BB.empty() && BB.back().isTerminator())
315 continue;
316
317 if (OS) {
318 *OS << "Basic Block in function '" << F.getName()
319 << "' does not have terminator!\n";
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000320 BB.printAsOperand(*OS, true, MST);
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000321 *OS << "\n";
Chandler Carruth76777602014-01-17 10:56:02 +0000322 }
Duncan P. N. Exon Smith8ec8da42016-04-20 18:27:18 +0000323 return false;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000324 }
Chandler Carruth76777602014-01-17 10:56:02 +0000325
Chandler Carruth043949d2014-01-19 02:22:18 +0000326 Broken = false;
327 // FIXME: We strip const here because the inst visitor strips const.
328 visit(const_cast<Function &>(F));
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000329 verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000330 InstsInThisBlock.clear();
David Majnemer654e1302015-07-31 17:58:14 +0000331 LandingPadResultTy = nullptr;
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000332 SawFrameEscape = false;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000333 SiblingFuncletInfo.clear();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000334
Chandler Carruth043949d2014-01-19 02:22:18 +0000335 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000336 }
337
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000338 /// Verify the module that this instance of \c Verifier was initialized with.
339 bool verify() {
Chandler Carruth043949d2014-01-19 02:22:18 +0000340 Broken = false;
341
Peter Collingbournebb738172016-06-06 23:21:27 +0000342 // Collect all declarations of the llvm.experimental.deoptimize intrinsic.
343 for (const Function &F : M)
344 if (F.getIntrinsicID() == Intrinsic::experimental_deoptimize)
345 DeoptimizeDeclarations.push_back(&F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000346
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000347 // Now that we've visited every function, verify that we never asked to
348 // recover a frame index that wasn't escaped.
349 verifyFrameRecoverIndices();
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000350 for (const GlobalVariable &GV : M.globals())
351 visitGlobalVariable(GV);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000352
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000353 for (const GlobalAlias &GA : M.aliases())
354 visitGlobalAlias(GA);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000355
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000356 for (const NamedMDNode &NMD : M.named_metadata())
357 visitNamedMDNode(NMD);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000358
David Majnemerdad0a642014-06-27 18:19:56 +0000359 for (const StringMapEntry<Comdat> &SMEC : M.getComdatSymbolTable())
360 visitComdat(SMEC.getValue());
361
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000362 visitModuleFlags(M);
363 visitModuleIdents(M);
364
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000365 verifyCompileUnits();
366
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000367 verifyDeoptimizeCallingConvs();
368
Chandler Carruth043949d2014-01-19 02:22:18 +0000369 return !Broken;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000370 }
Chris Lattner9713b842002-04-28 16:04:26 +0000371
Chandler Carruth043949d2014-01-19 02:22:18 +0000372private:
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000373 // Verification methods...
Chandler Carruth043949d2014-01-19 02:22:18 +0000374 void visitGlobalValue(const GlobalValue &GV);
375 void visitGlobalVariable(const GlobalVariable &GV);
376 void visitGlobalAlias(const GlobalAlias &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000377 void visitAliaseeSubExpr(const GlobalAlias &A, const Constant &C);
Craig Topper71b7b682014-08-21 05:55:13 +0000378 void visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias *> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000379 const GlobalAlias &A, const Constant &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000380 void visitNamedMDNode(const NamedMDNode &NMD);
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000381 void visitMDNode(const MDNode &MD);
382 void visitMetadataAsValue(const MetadataAsValue &MD, Function *F);
383 void visitValueAsMetadata(const ValueAsMetadata &MD, Function *F);
David Majnemerdad0a642014-06-27 18:19:56 +0000384 void visitComdat(const Comdat &C);
Chandler Carruth043949d2014-01-19 02:22:18 +0000385 void visitModuleIdents(const Module &M);
386 void visitModuleFlags(const Module &M);
387 void visitModuleFlag(const MDNode *Op,
388 DenseMap<const MDString *, const MDNode *> &SeenIDs,
389 SmallVectorImpl<const MDNode *> &Requirements);
390 void visitFunction(const Function &F);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000391 void visitBasicBlock(BasicBlock &BB);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000392 void visitRangeMetadata(Instruction& I, MDNode* Range, Type* Ty);
Artur Pilipenkocca80022015-10-09 17:41:29 +0000393 void visitDereferenceableMetadata(Instruction& I, MDNode* MD);
Philip Reamesbf9676f2014-10-20 23:52:07 +0000394
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000395 template <class Ty> bool isValidMetadataArray(const MDTuple &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000396#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) void visit##CLASS(const CLASS &N);
397#include "llvm/IR/Metadata.def"
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000398 void visitDIScope(const DIScope &N);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000399 void visitDIVariable(const DIVariable &N);
400 void visitDILexicalBlockBase(const DILexicalBlockBase &N);
401 void visitDITemplateParameter(const DITemplateParameter &N);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000402
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000403 void visitTemplateParams(const MDNode &N, const Metadata &RawParams);
404
Chandler Carruth043949d2014-01-19 02:22:18 +0000405 // InstVisitor overrides...
406 using InstVisitor<Verifier>::visit;
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000407 void visit(Instruction &I);
408
409 void visitTruncInst(TruncInst &I);
410 void visitZExtInst(ZExtInst &I);
411 void visitSExtInst(SExtInst &I);
412 void visitFPTruncInst(FPTruncInst &I);
413 void visitFPExtInst(FPExtInst &I);
414 void visitFPToUIInst(FPToUIInst &I);
415 void visitFPToSIInst(FPToSIInst &I);
416 void visitUIToFPInst(UIToFPInst &I);
417 void visitSIToFPInst(SIToFPInst &I);
418 void visitIntToPtrInst(IntToPtrInst &I);
419 void visitPtrToIntInst(PtrToIntInst &I);
420 void visitBitCastInst(BitCastInst &I);
421 void visitAddrSpaceCastInst(AddrSpaceCastInst &I);
422 void visitPHINode(PHINode &PN);
423 void visitBinaryOperator(BinaryOperator &B);
424 void visitICmpInst(ICmpInst &IC);
425 void visitFCmpInst(FCmpInst &FC);
426 void visitExtractElementInst(ExtractElementInst &EI);
427 void visitInsertElementInst(InsertElementInst &EI);
428 void visitShuffleVectorInst(ShuffleVectorInst &EI);
429 void visitVAArgInst(VAArgInst &VAA) { visitInstruction(VAA); }
430 void visitCallInst(CallInst &CI);
431 void visitInvokeInst(InvokeInst &II);
432 void visitGetElementPtrInst(GetElementPtrInst &GEP);
433 void visitLoadInst(LoadInst &LI);
434 void visitStoreInst(StoreInst &SI);
435 void verifyDominatesUse(Instruction &I, unsigned i);
436 void visitInstruction(Instruction &I);
437 void visitTerminatorInst(TerminatorInst &I);
438 void visitBranchInst(BranchInst &BI);
439 void visitReturnInst(ReturnInst &RI);
440 void visitSwitchInst(SwitchInst &SI);
441 void visitIndirectBrInst(IndirectBrInst &BI);
442 void visitSelectInst(SelectInst &SI);
443 void visitUserOp1(Instruction &I);
444 void visitUserOp2(Instruction &I) { visitUserOp1(I); }
Philip Reames007561a2015-06-26 22:21:52 +0000445 void visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS);
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +0000446 template <class DbgIntrinsicTy>
447 void visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000448 void visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI);
449 void visitAtomicRMWInst(AtomicRMWInst &RMWI);
450 void visitFenceInst(FenceInst &FI);
451 void visitAllocaInst(AllocaInst &AI);
452 void visitExtractValueInst(ExtractValueInst &EVI);
453 void visitInsertValueInst(InsertValueInst &IVI);
David Majnemer85a549d2015-08-11 02:48:30 +0000454 void visitEHPadPredecessors(Instruction &I);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000455 void visitLandingPadInst(LandingPadInst &LPI);
David Majnemerba6665d2016-08-01 18:06:34 +0000456 void visitResumeInst(ResumeInst &RI);
David Majnemer654e1302015-07-31 17:58:14 +0000457 void visitCatchPadInst(CatchPadInst &CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000458 void visitCatchReturnInst(CatchReturnInst &CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +0000459 void visitCleanupPadInst(CleanupPadInst &CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +0000460 void visitFuncletPadInst(FuncletPadInst &FPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +0000461 void visitCatchSwitchInst(CatchSwitchInst &CatchSwitch);
David Majnemer654e1302015-07-31 17:58:14 +0000462 void visitCleanupReturnInst(CleanupReturnInst &CRI);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000463
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000464 void verifyCallSite(CallSite CS);
Manman Ren9bfd0d02016-04-01 21:41:15 +0000465 void verifySwiftErrorCallSite(CallSite CS, const Value *SwiftErrorVal);
466 void verifySwiftErrorValue(const Value *SwiftErrorVal);
Reid Kleckner5772b772014-04-24 20:14:34 +0000467 void verifyMustTailCall(CallInst &CI);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000468 bool performTypeCheck(Intrinsic::ID ID, Function *F, Type *Ty, int VT,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000469 unsigned ArgNo, std::string &Suffix);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000470 bool verifyAttributeCount(AttributeSet Attrs, unsigned Params);
471 void verifyAttributeTypes(AttributeSet Attrs, unsigned Idx, bool isFunction,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000472 const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000473 void verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000474 bool isReturnValue, const Value *V);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000475 void verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000476 const Value *V);
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +0000477 void verifyFunctionMetadata(ArrayRef<std::pair<unsigned, MDNode *>> MDs);
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000478
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000479 void visitConstantExprsRecursively(const Constant *EntryC);
480 void visitConstantExpr(const ConstantExpr *CE);
Sanjay Patelbbdab7a2016-01-31 16:32:23 +0000481 void verifyStatepoint(ImmutableCallSite CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +0000482 void verifyFrameRecoverIndices();
Joseph Tremoulet8ea80862016-01-10 04:31:05 +0000483 void verifySiblingFuncletUnwinds();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000484
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000485 void verifyBitPieceExpression(const DbgInfoIntrinsic &I);
486
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000487 /// Module-level debug info verification...
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000488 void verifyCompileUnits();
Sanjoy Dase0aa4142016-05-12 01:17:38 +0000489
490 /// Module-level verification that all @llvm.experimental.deoptimize
491 /// declarations share the same calling convention.
492 void verifyDeoptimizeCallingConvs();
Chandler Carruthbf2b6522014-01-17 11:09:34 +0000493};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000494
495} // end anonymous namespace
Chris Lattner189d19f2003-11-21 20:23:48 +0000496
Adrian Prantl541a9c52016-05-06 19:26:47 +0000497/// We know that cond should be true, if not print an error message.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000498#define Assert(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000499 do { if (!(C)) { CheckFailed(__VA_ARGS__); return; } } while (false)
Chris Lattner2f7c9632001-06-06 20:29:01 +0000500
Adrian Prantl541a9c52016-05-06 19:26:47 +0000501/// We know that a debug info condition should be true, if not print
502/// an error message.
503#define AssertDI(C, ...) \
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000504 do { if (!(C)) { DebugInfoCheckFailed(__VA_ARGS__); return; } } while (false)
Adrian Prantl541a9c52016-05-06 19:26:47 +0000505
Chris Lattnere5a22c02008-08-28 04:02:44 +0000506void Verifier::visit(Instruction &I) {
507 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000508 Assert(I.getOperand(i) != nullptr, "Operand is null", &I);
Chris Lattnere5a22c02008-08-28 04:02:44 +0000509 InstVisitor<Verifier>::visit(I);
510}
511
Keno Fischer60f82a22016-01-14 22:20:56 +0000512// Helper to recursively iterate over indirect users. By
513// returning false, the callback can ask to stop recursing
514// further.
515static void forEachUser(const Value *User,
516 SmallPtrSet<const Value *, 32> &Visited,
517 llvm::function_ref<bool(const Value *)> Callback) {
518 if (!Visited.insert(User).second)
519 return;
Rafael Espindola257a3532016-01-15 19:00:20 +0000520 for (const Value *TheNextUser : User->materialized_users())
Keno Fischer60f82a22016-01-14 22:20:56 +0000521 if (Callback(TheNextUser))
522 forEachUser(TheNextUser, Visited, Callback);
523}
Chris Lattnere5a22c02008-08-28 04:02:44 +0000524
Chandler Carruth043949d2014-01-19 02:22:18 +0000525void Verifier::visitGlobalValue(const GlobalValue &GV) {
Rafael Espindola4787ba32016-05-11 13:51:39 +0000526 Assert(!GV.isDeclaration() || GV.hasValidDeclarationLinkage(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000527 "Global is external, but doesn't have external or weak linkage!", &GV);
Anton Korobeynikovd61d39e2006-09-14 18:23:27 +0000528
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000529 Assert(GV.getAlignment() <= Value::MaximumAlignment,
530 "huge alignment values are unsupported", &GV);
531 Assert(!GV.hasAppendingLinkage() || isa<GlobalVariable>(GV),
532 "Only global variables can have appending linkage!", &GV);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000533
534 if (GV.hasAppendingLinkage()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000535 const GlobalVariable *GVar = dyn_cast<GlobalVariable>(&GV);
David Blaikie60310f22015-05-08 00:42:26 +0000536 Assert(GVar && GVar->getValueType()->isArrayTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000537 "Only global arrays can have appending linkage!", GVar);
Chris Lattner3ac483b2003-04-16 20:42:40 +0000538 }
Peter Collingbourne46eb0f52015-07-05 20:52:40 +0000539
540 if (GV.isDeclarationForLinker())
541 Assert(!GV.hasComdat(), "Declaration may not be in a Comdat!", &GV);
Keno Fischer60f82a22016-01-14 22:20:56 +0000542
Ivan Krasin3b1c2602016-01-20 08:41:22 +0000543 forEachUser(&GV, GlobalValueVisited, [&](const Value *V) -> bool {
Keno Fischer60f82a22016-01-14 22:20:56 +0000544 if (const Instruction *I = dyn_cast<Instruction>(V)) {
545 if (!I->getParent() || !I->getParent()->getParent())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000546 CheckFailed("Global is referenced by parentless instruction!", &GV, &M,
547 I);
548 else if (I->getParent()->getParent()->getParent() != &M)
549 CheckFailed("Global is referenced in a different module!", &GV, &M, I,
550 I->getParent()->getParent(),
Keno Fischer60f82a22016-01-14 22:20:56 +0000551 I->getParent()->getParent()->getParent());
552 return false;
553 } else if (const Function *F = dyn_cast<Function>(V)) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000554 if (F->getParent() != &M)
555 CheckFailed("Global is used by function in a different module", &GV, &M,
556 F, F->getParent());
Keno Fischer60f82a22016-01-14 22:20:56 +0000557 return false;
558 }
559 return true;
560 });
Chris Lattner3ac483b2003-04-16 20:42:40 +0000561}
562
Chandler Carruth043949d2014-01-19 02:22:18 +0000563void Verifier::visitGlobalVariable(const GlobalVariable &GV) {
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000564 if (GV.hasInitializer()) {
Manuel Jacob5f6eaac2016-01-16 20:30:46 +0000565 Assert(GV.getInitializer()->getType() == GV.getValueType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000566 "Global variable initializer type does not match global "
567 "variable type!",
568 &GV);
Nick Lewyckyadbc2842009-05-30 05:06:04 +0000569
Chris Lattner0aff0b22009-08-05 05:41:44 +0000570 // If the global has common linkage, it must have a zero initializer and
571 // cannot be constant.
572 if (GV.hasCommonLinkage()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000573 Assert(GV.getInitializer()->isNullValue(),
574 "'common' global must have a zero initializer!", &GV);
575 Assert(!GV.isConstant(), "'common' global may not be marked constant!",
576 &GV);
577 Assert(!GV.hasComdat(), "'common' global may not be in a Comdat!", &GV);
Chris Lattner0aff0b22009-08-05 05:41:44 +0000578 }
Chris Lattnerd79f3d52007-09-19 17:14:45 +0000579 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000580
Nick Lewycky466d0c12011-04-08 07:30:21 +0000581 if (GV.hasName() && (GV.getName() == "llvm.global_ctors" ||
582 GV.getName() == "llvm.global_dtors")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000583 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
584 "invalid linkage for intrinsic global variable", &GV);
Nick Lewycky466d0c12011-04-08 07:30:21 +0000585 // Don't worry about emitting an error for it not being an array,
586 // visitGlobalValue will complain on appending non-array.
David Blaikie60310f22015-05-08 00:42:26 +0000587 if (ArrayType *ATy = dyn_cast<ArrayType>(GV.getValueType())) {
Chris Lattner229907c2011-07-18 04:54:35 +0000588 StructType *STy = dyn_cast<StructType>(ATy->getElementType());
589 PointerType *FuncPtrTy =
Sanjoy Das4b54b7f2016-08-02 01:34:50 +0000590 FunctionType::get(Type::getVoidTy(Context), false)->getPointerTo();
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000591 // FIXME: Reject the 2-field form in LLVM 4.0.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000592 Assert(STy &&
593 (STy->getNumElements() == 2 || STy->getNumElements() == 3) &&
594 STy->getTypeAtIndex(0u)->isIntegerTy(32) &&
595 STy->getTypeAtIndex(1) == FuncPtrTy,
596 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000597 if (STy->getNumElements() == 3) {
598 Type *ETy = STy->getTypeAtIndex(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000599 Assert(ETy->isPointerTy() &&
600 cast<PointerType>(ETy)->getElementType()->isIntegerTy(8),
601 "wrong type for intrinsic global variable", &GV);
Reid Klecknerfceb76f2014-05-16 20:39:27 +0000602 }
Nick Lewycky466d0c12011-04-08 07:30:21 +0000603 }
604 }
605
Rafael Espindola8bd2c222013-04-22 15:16:51 +0000606 if (GV.hasName() && (GV.getName() == "llvm.used" ||
Rafael Espindola9aadcc42013-07-19 18:44:51 +0000607 GV.getName() == "llvm.compiler.used")) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000608 Assert(!GV.hasInitializer() || GV.hasAppendingLinkage(),
609 "invalid linkage for intrinsic global variable", &GV);
David Blaikie0c28fd72015-05-20 21:46:30 +0000610 Type *GVType = GV.getValueType();
Rafael Espindola74f2e462013-04-22 14:58:02 +0000611 if (ArrayType *ATy = dyn_cast<ArrayType>(GVType)) {
612 PointerType *PTy = dyn_cast<PointerType>(ATy->getElementType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000613 Assert(PTy, "wrong type for intrinsic global variable", &GV);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000614 if (GV.hasInitializer()) {
Chandler Carruth043949d2014-01-19 02:22:18 +0000615 const Constant *Init = GV.getInitializer();
616 const ConstantArray *InitArray = dyn_cast<ConstantArray>(Init);
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000617 Assert(InitArray, "wrong initalizer for intrinsic global variable",
618 Init);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000619 for (Value *Op : InitArray->operands()) {
620 Value *V = Op->stripPointerCastsNoFollowAliases();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000621 Assert(isa<GlobalVariable>(V) || isa<Function>(V) ||
622 isa<GlobalAlias>(V),
623 "invalid llvm.used member", V);
624 Assert(V->hasName(), "members of llvm.used must be named", V);
Rafael Espindola74f2e462013-04-22 14:58:02 +0000625 }
626 }
627 }
628 }
629
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000630 Assert(!GV.hasDLLImportStorageClass() ||
631 (GV.isDeclaration() && GV.hasExternalLinkage()) ||
632 GV.hasAvailableExternallyLinkage(),
633 "Global is marked as dllimport, but not external", &GV);
Nico Rieck7157bb72014-01-14 15:22:47 +0000634
Matt Arsenault24b49c42013-07-31 17:49:08 +0000635 if (!GV.hasInitializer()) {
636 visitGlobalValue(GV);
637 return;
638 }
639
640 // Walk any aggregate initializers looking for bitcasts between address spaces
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000641 visitConstantExprsRecursively(GV.getInitializer());
Matt Arsenault24b49c42013-07-31 17:49:08 +0000642
Chris Lattnere3400652004-12-15 20:23:49 +0000643 visitGlobalValue(GV);
644}
645
Rafael Espindola64c1e182014-06-03 02:41:57 +0000646void Verifier::visitAliaseeSubExpr(const GlobalAlias &GA, const Constant &C) {
647 SmallPtrSet<const GlobalAlias*, 4> Visited;
648 Visited.insert(&GA);
649 visitAliaseeSubExpr(Visited, GA, C);
650}
651
Craig Topper71b7b682014-08-21 05:55:13 +0000652void Verifier::visitAliaseeSubExpr(SmallPtrSetImpl<const GlobalAlias*> &Visited,
Rafael Espindola64c1e182014-06-03 02:41:57 +0000653 const GlobalAlias &GA, const Constant &C) {
654 if (const auto *GV = dyn_cast<GlobalValue>(&C)) {
Rafael Espindola89345772015-11-26 19:22:59 +0000655 Assert(!GV->isDeclarationForLinker(), "Alias must point to a definition",
656 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000657
658 if (const auto *GA2 = dyn_cast<GlobalAlias>(GV)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000659 Assert(Visited.insert(GA2).second, "Aliases cannot form a cycle", &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000660
Sanjoy Das5ce32722016-04-08 00:48:30 +0000661 Assert(!GA2->isInterposable(), "Alias cannot point to an interposable alias",
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000662 &GA);
Bob Wilson2f7cc012014-06-12 01:46:54 +0000663 } else {
664 // Only continue verifying subexpressions of GlobalAliases.
665 // Do not recurse into global initializers.
666 return;
Rafael Espindola64c1e182014-06-03 02:41:57 +0000667 }
668 }
669
670 if (const auto *CE = dyn_cast<ConstantExpr>(&C))
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +0000671 visitConstantExprsRecursively(CE);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000672
673 for (const Use &U : C.operands()) {
674 Value *V = &*U;
675 if (const auto *GA2 = dyn_cast<GlobalAlias>(V))
676 visitAliaseeSubExpr(Visited, GA, *GA2->getAliasee());
677 else if (const auto *C2 = dyn_cast<Constant>(V))
678 visitAliaseeSubExpr(Visited, GA, *C2);
679 }
680}
681
Chandler Carruth043949d2014-01-19 02:22:18 +0000682void Verifier::visitGlobalAlias(const GlobalAlias &GA) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000683 Assert(GlobalAlias::isValidLinkage(GA.getLinkage()),
684 "Alias should have private, internal, linkonce, weak, linkonce_odr, "
685 "weak_odr, or external linkage!",
686 &GA);
Rafael Espindola64c1e182014-06-03 02:41:57 +0000687 const Constant *Aliasee = GA.getAliasee();
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000688 Assert(Aliasee, "Aliasee cannot be NULL!", &GA);
689 Assert(GA.getType() == Aliasee->getType(),
690 "Alias and aliasee types should match!", &GA);
Anton Korobeynikova50eed42008-05-08 23:11:06 +0000691
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000692 Assert(isa<GlobalValue>(Aliasee) || isa<ConstantExpr>(Aliasee),
693 "Aliasee should be either GlobalValue or ConstantExpr", &GA);
Matt Arsenault828b5652013-07-20 17:46:05 +0000694
Rafael Espindola64c1e182014-06-03 02:41:57 +0000695 visitAliaseeSubExpr(GA, *Aliasee);
Anton Korobeynikov25b2e822008-03-22 08:36:14 +0000696
Anton Korobeynikova97b6942007-04-25 14:27:10 +0000697 visitGlobalValue(GA);
698}
699
Chandler Carruth043949d2014-01-19 02:22:18 +0000700void Verifier::visitNamedMDNode(const NamedMDNode &NMD) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000701 for (const MDNode *MD : NMD.operands()) {
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000702 if (NMD.getName() == "llvm.dbg.cu") {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000703 AssertDI(MD && isa<DICompileUnit>(MD), "invalid compile unit", &NMD, MD);
Duncan P. N. Exon Smithf238c782015-03-24 17:18:03 +0000704 }
705
Duncan P. N. Exon Smithd23ddbd2015-03-31 02:27:32 +0000706 if (!MD)
707 continue;
708
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000709 visitMDNode(*MD);
Duncan Sands76d62172010-04-29 16:10:30 +0000710 }
711}
712
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000713void Verifier::visitMDNode(const MDNode &MD) {
Duncan Sands76d62172010-04-29 16:10:30 +0000714 // Only visit each node once. Metadata can be mutually recursive, so this
715 // avoids infinite recursion here, as well as being an optimization.
David Blaikie70573dc2014-11-19 07:49:26 +0000716 if (!MDNodes.insert(&MD).second)
Duncan Sands76d62172010-04-29 16:10:30 +0000717 return;
718
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000719 switch (MD.getMetadataID()) {
720 default:
721 llvm_unreachable("Invalid MDNode subclass");
722 case Metadata::MDTupleKind:
723 break;
724#define HANDLE_SPECIALIZED_MDNODE_LEAF(CLASS) \
725 case Metadata::CLASS##Kind: \
726 visit##CLASS(cast<CLASS>(MD)); \
727 break;
728#include "llvm/IR/Metadata.def"
729 }
730
Sanjay Patel1f26bcf2016-02-25 16:44:27 +0000731 for (const Metadata *Op : MD.operands()) {
Duncan Sands76d62172010-04-29 16:10:30 +0000732 if (!Op)
733 continue;
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000734 Assert(!isa<LocalAsMetadata>(Op), "Invalid operand for global metadata!",
735 &MD, Op);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000736 if (auto *N = dyn_cast<MDNode>(Op)) {
737 visitMDNode(*N);
Duncan Sands76d62172010-04-29 16:10:30 +0000738 continue;
739 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000740 if (auto *V = dyn_cast<ValueAsMetadata>(Op)) {
741 visitValueAsMetadata(*V, nullptr);
742 continue;
743 }
Duncan Sands76d62172010-04-29 16:10:30 +0000744 }
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000745
746 // Check these last, so we diagnose problems in operands first.
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000747 Assert(!MD.isTemporary(), "Expected no forward declarations!", &MD);
748 Assert(MD.isResolved(), "All nodes should be resolved!", &MD);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000749}
750
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000751void Verifier::visitValueAsMetadata(const ValueAsMetadata &MD, Function *F) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000752 Assert(MD.getValue(), "Expected valid value", &MD);
753 Assert(!MD.getValue()->getType()->isMetadataTy(),
754 "Unexpected metadata round-trip through values", &MD, MD.getValue());
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000755
756 auto *L = dyn_cast<LocalAsMetadata>(&MD);
757 if (!L)
758 return;
759
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000760 Assert(F, "function-local metadata used outside a function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000761
762 // If this was an instruction, bb, or argument, verify that it is in the
763 // function that we expect.
764 Function *ActualF = nullptr;
765 if (Instruction *I = dyn_cast<Instruction>(L->getValue())) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000766 Assert(I->getParent(), "function-local metadata not in basic block", L, I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000767 ActualF = I->getParent()->getParent();
768 } else if (BasicBlock *BB = dyn_cast<BasicBlock>(L->getValue()))
769 ActualF = BB->getParent();
770 else if (Argument *A = dyn_cast<Argument>(L->getValue()))
771 ActualF = A->getParent();
772 assert(ActualF && "Unimplemented function local metadata case!");
773
Benjamin Kramerf027ad72015-03-07 21:15:40 +0000774 Assert(ActualF == F, "function-local metadata used in wrong function", L);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000775}
776
Duncan P. N. Exon Smithac3ed7a2015-02-09 21:30:05 +0000777void Verifier::visitMetadataAsValue(const MetadataAsValue &MDV, Function *F) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +0000778 Metadata *MD = MDV.getMetadata();
779 if (auto *N = dyn_cast<MDNode>(MD)) {
780 visitMDNode(*N);
781 return;
782 }
783
784 // Only visit each node once. Metadata can be mutually recursive, so this
785 // avoids infinite recursion here, as well as being an optimization.
786 if (!MDNodes.insert(MD).second)
787 return;
788
789 if (auto *V = dyn_cast<ValueAsMetadata>(MD))
790 visitValueAsMetadata(*V, F);
Duncan Sands76d62172010-04-29 16:10:30 +0000791}
792
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +0000793static bool isType(const Metadata *MD) { return !MD || isa<DIType>(MD); }
794static bool isScope(const Metadata *MD) { return !MD || isa<DIScope>(MD); }
795static bool isDINode(const Metadata *MD) { return !MD || isa<DINode>(MD); }
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +0000796
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000797template <class Ty>
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000798static bool isValidMetadataArrayImpl(const MDTuple &N, bool AllowNull) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000799 for (Metadata *MD : N.operands()) {
800 if (MD) {
801 if (!isa<Ty>(MD))
802 return false;
803 } else {
804 if (!AllowNull)
805 return false;
806 }
807 }
808 return true;
809}
810
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000811template <class Ty> static bool isValidMetadataArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000812 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ false);
813}
814
Benjamin Kramerb7d33112016-08-06 11:13:10 +0000815template <class Ty> static bool isValidMetadataNullArray(const MDTuple &N) {
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000816 return isValidMetadataArrayImpl<Ty>(N, /* AllowNull */ true);
817}
818
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000819void Verifier::visitDILocation(const DILocation &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000820 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
821 "location requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smith26489982015-03-26 22:05:04 +0000822 if (auto *IA = N.getRawInlinedAt())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000823 AssertDI(isa<DILocation>(IA), "inlined-at should be a location", &N, IA);
Duncan P. N. Exon Smith692bdb92015-02-10 01:32:56 +0000824}
825
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000826void Verifier::visitGenericDINode(const GenericDINode &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000827 AssertDI(N.getTag(), "invalid tag", &N);
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +0000828}
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000829
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000830void Verifier::visitDIScope(const DIScope &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000831 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000832 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000833}
834
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000835void Verifier::visitDISubrange(const DISubrange &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000836 AssertDI(N.getTag() == dwarf::DW_TAG_subrange_type, "invalid tag", &N);
837 AssertDI(N.getCount() >= -1, "invalid subrange count", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000838}
839
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000840void Verifier::visitDIEnumerator(const DIEnumerator &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000841 AssertDI(N.getTag() == dwarf::DW_TAG_enumerator, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000842}
843
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000844void Verifier::visitDIBasicType(const DIBasicType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000845 AssertDI(N.getTag() == dwarf::DW_TAG_base_type ||
846 N.getTag() == dwarf::DW_TAG_unspecified_type,
847 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000848}
849
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000850void Verifier::visitDIDerivedType(const DIDerivedType &N) {
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000851 // Common scope checks.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000852 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000853
Adrian Prantl541a9c52016-05-06 19:26:47 +0000854 AssertDI(N.getTag() == dwarf::DW_TAG_typedef ||
855 N.getTag() == dwarf::DW_TAG_pointer_type ||
856 N.getTag() == dwarf::DW_TAG_ptr_to_member_type ||
857 N.getTag() == dwarf::DW_TAG_reference_type ||
858 N.getTag() == dwarf::DW_TAG_rvalue_reference_type ||
859 N.getTag() == dwarf::DW_TAG_const_type ||
860 N.getTag() == dwarf::DW_TAG_volatile_type ||
861 N.getTag() == dwarf::DW_TAG_restrict_type ||
862 N.getTag() == dwarf::DW_TAG_member ||
863 N.getTag() == dwarf::DW_TAG_inheritance ||
864 N.getTag() == dwarf::DW_TAG_friend,
865 "invalid tag", &N);
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000866 if (N.getTag() == dwarf::DW_TAG_ptr_to_member_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000867 AssertDI(isType(N.getRawExtraData()), "invalid pointer to member type", &N,
868 N.getRawExtraData());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000869 }
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000870
Adrian Prantl541a9c52016-05-06 19:26:47 +0000871 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
872 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
873 N.getRawBaseType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000874}
875
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000876static bool hasConflictingReferenceFlags(unsigned Flags) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000877 return (Flags & DINode::FlagLValueReference) &&
878 (Flags & DINode::FlagRValueReference);
Duncan P. N. Exon Smith85866b2a2015-03-31 01:28:58 +0000879}
880
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000881void Verifier::visitTemplateParams(const MDNode &N, const Metadata &RawParams) {
882 auto *Params = dyn_cast<MDTuple>(&RawParams);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000883 AssertDI(Params, "invalid template params", &N, &RawParams);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000884 for (Metadata *Op : Params->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000885 AssertDI(Op && isa<DITemplateParameter>(Op), "invalid template parameter",
886 &N, Params, Op);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000887 }
888}
889
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000890void Verifier::visitDICompositeType(const DICompositeType &N) {
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000891 // Common scope checks.
892 visitDIScope(N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000893
Adrian Prantl541a9c52016-05-06 19:26:47 +0000894 AssertDI(N.getTag() == dwarf::DW_TAG_array_type ||
895 N.getTag() == dwarf::DW_TAG_structure_type ||
896 N.getTag() == dwarf::DW_TAG_union_type ||
897 N.getTag() == dwarf::DW_TAG_enumeration_type ||
898 N.getTag() == dwarf::DW_TAG_class_type,
899 "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000900
Adrian Prantl541a9c52016-05-06 19:26:47 +0000901 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
902 AssertDI(isType(N.getRawBaseType()), "invalid base type", &N,
903 N.getRawBaseType());
Duncan P. N. Exon Smith338aef02015-07-24 20:16:36 +0000904
Adrian Prantl541a9c52016-05-06 19:26:47 +0000905 AssertDI(!N.getRawElements() || isa<MDTuple>(N.getRawElements()),
906 "invalid composite elements", &N, N.getRawElements());
907 AssertDI(isType(N.getRawVTableHolder()), "invalid vtable holder", &N,
908 N.getRawVTableHolder());
909 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
910 "invalid reference flags", &N);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +0000911 if (auto *Params = N.getRawTemplateParams())
912 visitTemplateParams(N, *Params);
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000913
914 if (N.getTag() == dwarf::DW_TAG_class_type ||
915 N.getTag() == dwarf::DW_TAG_union_type) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000916 AssertDI(N.getFile() && !N.getFile()->getFilename().empty(),
917 "class/union requires a filename", &N, N.getFile());
Duncan P. N. Exon Smithdbfc0102015-07-24 19:57:19 +0000918 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000919}
920
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000921void Verifier::visitDISubroutineType(const DISubroutineType &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000922 AssertDI(N.getTag() == dwarf::DW_TAG_subroutine_type, "invalid tag", &N);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000923 if (auto *Types = N.getRawTypeArray()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000924 AssertDI(isa<MDTuple>(Types), "invalid composite elements", &N, Types);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000925 for (Metadata *Ty : N.getTypeArray()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000926 AssertDI(isType(Ty), "invalid subroutine type ref", &N, Types, Ty);
Duncan P. N. Exon Smitha8b3a1f2015-03-28 02:43:53 +0000927 }
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000928 }
Adrian Prantl541a9c52016-05-06 19:26:47 +0000929 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
930 "invalid reference flags", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000931}
932
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000933void Verifier::visitDIFile(const DIFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000934 AssertDI(N.getTag() == dwarf::DW_TAG_file_type, "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000935}
936
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000937void Verifier::visitDICompileUnit(const DICompileUnit &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000938 AssertDI(N.isDistinct(), "compile units must be distinct", &N);
939 AssertDI(N.getTag() == dwarf::DW_TAG_compile_unit, "invalid tag", &N);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000940
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000941 // Don't bother verifying the compilation directory or producer string
942 // as those could be empty.
Adrian Prantl541a9c52016-05-06 19:26:47 +0000943 AssertDI(N.getRawFile() && isa<DIFile>(N.getRawFile()), "invalid file", &N,
944 N.getRawFile());
945 AssertDI(!N.getFile()->getFilename().empty(), "invalid filename", &N,
946 N.getFile());
Duncan P. N. Exon Smithcd07efa12015-03-31 00:47:15 +0000947
Adrian Prantl541a9c52016-05-06 19:26:47 +0000948 AssertDI((N.getEmissionKind() <= DICompileUnit::LastEmissionKind),
949 "invalid emission kind", &N);
Adrian Prantlb939a252016-03-31 23:56:58 +0000950
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000951 if (auto *Array = N.getRawEnumTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000952 AssertDI(isa<MDTuple>(Array), "invalid enum list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000953 for (Metadata *Op : N.getEnumTypes()->operands()) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000954 auto *Enum = dyn_cast_or_null<DICompositeType>(Op);
Adrian Prantl541a9c52016-05-06 19:26:47 +0000955 AssertDI(Enum && Enum->getTag() == dwarf::DW_TAG_enumeration_type,
956 "invalid enum type", &N, N.getEnumTypes(), Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000957 }
958 }
959 if (auto *Array = N.getRawRetainedTypes()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000960 AssertDI(isa<MDTuple>(Array), "invalid retained type list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000961 for (Metadata *Op : N.getRetainedTypes()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000962 AssertDI(Op && (isa<DIType>(Op) ||
963 (isa<DISubprogram>(Op) &&
Eugene Zelenko3e3a0572016-08-13 00:50:41 +0000964 !cast<DISubprogram>(Op)->isDefinition())),
Adrian Prantl541a9c52016-05-06 19:26:47 +0000965 "invalid retained type", &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000966 }
967 }
968 if (auto *Array = N.getRawGlobalVariables()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000969 AssertDI(isa<MDTuple>(Array), "invalid global variable list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000970 for (Metadata *Op : N.getGlobalVariables()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000971 AssertDI(Op && isa<DIGlobalVariable>(Op), "invalid global variable ref",
972 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000973 }
974 }
975 if (auto *Array = N.getRawImportedEntities()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000976 AssertDI(isa<MDTuple>(Array), "invalid imported entity list", &N, Array);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000977 for (Metadata *Op : N.getImportedEntities()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000978 AssertDI(Op && isa<DIImportedEntity>(Op), "invalid imported entity ref",
979 &N, Op);
Duncan P. N. Exon Smith53855f02015-03-27 23:05:04 +0000980 }
981 }
Amjad Abouda9bcf162015-12-10 12:56:35 +0000982 if (auto *Array = N.getRawMacros()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000983 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000984 for (Metadata *Op : N.getMacros()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000985 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +0000986 }
987 }
Adrian Prantlfaebbb02016-03-28 21:06:26 +0000988 CUVisited.insert(&N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +0000989}
990
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000991void Verifier::visitDISubprogram(const DISubprogram &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +0000992 AssertDI(N.getTag() == dwarf::DW_TAG_subprogram, "invalid tag", &N);
993 AssertDI(isScope(N.getRawScope()), "invalid scope", &N, N.getRawScope());
Davide Italiano5f1c87b2016-04-06 18:46:39 +0000994 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000995 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +0000996 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +0000997 AssertDI(isa<DISubroutineType>(T), "invalid subroutine type", &N, T);
998 AssertDI(isType(N.getRawContainingType()), "invalid containing type", &N,
999 N.getRawContainingType());
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001000 if (auto *Params = N.getRawTemplateParams())
1001 visitTemplateParams(N, *Params);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001002 if (auto *S = N.getRawDeclaration())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001003 AssertDI(isa<DISubprogram>(S) && !cast<DISubprogram>(S)->isDefinition(),
1004 "invalid subprogram declaration", &N, S);
Duncan P. N. Exon Smith936c5632015-04-06 17:04:58 +00001005 if (auto *RawVars = N.getRawVariables()) {
1006 auto *Vars = dyn_cast<MDTuple>(RawVars);
Adrian Prantl541a9c52016-05-06 19:26:47 +00001007 AssertDI(Vars, "invalid variable list", &N, RawVars);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001008 for (Metadata *Op : Vars->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001009 AssertDI(Op && isa<DILocalVariable>(Op), "invalid local variable", &N,
1010 Vars, Op);
Duncan P. N. Exon Smith869db502015-03-30 16:19:15 +00001011 }
1012 }
Adrian Prantl541a9c52016-05-06 19:26:47 +00001013 AssertDI(!hasConflictingReferenceFlags(N.getFlags()),
1014 "invalid reference flags", &N);
Duncan P. N. Exon Smith3ee34e12015-03-31 02:09:55 +00001015
Adrian Prantl75819ae2016-04-15 15:57:41 +00001016 auto *Unit = N.getRawUnit();
1017 if (N.isDefinition()) {
1018 // Subprogram definitions (not part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001019 AssertDI(N.isDistinct(), "subprogram definitions must be distinct", &N);
1020 AssertDI(Unit, "subprogram definitions must have a compile unit", &N);
1021 AssertDI(isa<DICompileUnit>(Unit), "invalid unit type", &N, Unit);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001022 } else {
1023 // Subprogram declarations (part of the type hierarchy).
Adrian Prantl541a9c52016-05-06 19:26:47 +00001024 AssertDI(!Unit, "subprogram declarations must not have a compile unit", &N);
Adrian Prantl75819ae2016-04-15 15:57:41 +00001025 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001026}
1027
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001028void Verifier::visitDILexicalBlockBase(const DILexicalBlockBase &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001029 AssertDI(N.getTag() == dwarf::DW_TAG_lexical_block, "invalid tag", &N);
1030 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1031 "invalid local scope", &N, N.getRawScope());
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001032}
1033
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001034void Verifier::visitDILexicalBlock(const DILexicalBlock &N) {
1035 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +00001036
Adrian Prantl541a9c52016-05-06 19:26:47 +00001037 AssertDI(N.getLine() || !N.getColumn(),
1038 "cannot have column info without line info", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001039}
1040
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001041void Verifier::visitDILexicalBlockFile(const DILexicalBlockFile &N) {
1042 visitDILexicalBlockBase(N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001043}
1044
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001045void Verifier::visitDINamespace(const DINamespace &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001046 AssertDI(N.getTag() == dwarf::DW_TAG_namespace, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001047 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001048 AssertDI(isa<DIScope>(S), "invalid scope ref", &N, S);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001049}
1050
Amjad Abouda9bcf162015-12-10 12:56:35 +00001051void Verifier::visitDIMacro(const DIMacro &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001052 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_define ||
1053 N.getMacinfoType() == dwarf::DW_MACINFO_undef,
1054 "invalid macinfo type", &N);
1055 AssertDI(!N.getName().empty(), "anonymous macro", &N);
Amjad Aboudd7cfb482016-01-07 14:28:20 +00001056 if (!N.getValue().empty()) {
1057 assert(N.getValue().data()[0] != ' ' && "Macro value has a space prefix");
1058 }
Amjad Abouda9bcf162015-12-10 12:56:35 +00001059}
1060
1061void Verifier::visitDIMacroFile(const DIMacroFile &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001062 AssertDI(N.getMacinfoType() == dwarf::DW_MACINFO_start_file,
1063 "invalid macinfo type", &N);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001064 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001065 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001066
1067 if (auto *Array = N.getRawElements()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001068 AssertDI(isa<MDTuple>(Array), "invalid macro list", &N, Array);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001069 for (Metadata *Op : N.getElements()->operands()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001070 AssertDI(Op && isa<DIMacroNode>(Op), "invalid macro ref", &N, Op);
Amjad Abouda9bcf162015-12-10 12:56:35 +00001071 }
1072 }
1073}
1074
Adrian Prantlab1243f2015-06-29 23:03:47 +00001075void Verifier::visitDIModule(const DIModule &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001076 AssertDI(N.getTag() == dwarf::DW_TAG_module, "invalid tag", &N);
1077 AssertDI(!N.getName().empty(), "anonymous module", &N);
Adrian Prantlab1243f2015-06-29 23:03:47 +00001078}
1079
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001080void Verifier::visitDITemplateParameter(const DITemplateParameter &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001081 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001082}
1083
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001084void Verifier::visitDITemplateTypeParameter(const DITemplateTypeParameter &N) {
1085 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001086
Adrian Prantl541a9c52016-05-06 19:26:47 +00001087 AssertDI(N.getTag() == dwarf::DW_TAG_template_type_parameter, "invalid tag",
1088 &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001089}
1090
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001091void Verifier::visitDITemplateValueParameter(
1092 const DITemplateValueParameter &N) {
1093 visitDITemplateParameter(N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001094
Adrian Prantl541a9c52016-05-06 19:26:47 +00001095 AssertDI(N.getTag() == dwarf::DW_TAG_template_value_parameter ||
1096 N.getTag() == dwarf::DW_TAG_GNU_template_template_param ||
1097 N.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack,
1098 "invalid tag", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001099}
1100
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001101void Verifier::visitDIVariable(const DIVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001102 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001103 AssertDI(isa<DIScope>(S), "invalid scope", &N, S);
1104 AssertDI(isType(N.getRawType()), "invalid type ref", &N, N.getRawType());
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001105 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001106 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001107}
1108
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001109void Verifier::visitDIGlobalVariable(const DIGlobalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001110 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001111 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001112
Adrian Prantl541a9c52016-05-06 19:26:47 +00001113 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1114 AssertDI(!N.getName().empty(), "missing global variable name", &N);
Peter Collingbourned4135bb2016-09-13 01:12:59 +00001115 if (auto *V = N.getRawExpr())
1116 AssertDI(isa<DIExpression>(V), "invalid expression location", &N, V);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001117 if (auto *Member = N.getRawStaticDataMemberDeclaration()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001118 AssertDI(isa<DIDerivedType>(Member),
1119 "invalid static data member declaration", &N, Member);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001120 }
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001121}
1122
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001123void Verifier::visitDILocalVariable(const DILocalVariable &N) {
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001124 // Checks common to all variables.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001125 visitDIVariable(N);
Duncan P. N. Exon Smith3d2afaa2015-03-27 17:29:58 +00001126
Adrian Prantl541a9c52016-05-06 19:26:47 +00001127 AssertDI(N.getTag() == dwarf::DW_TAG_variable, "invalid tag", &N);
1128 AssertDI(N.getRawScope() && isa<DILocalScope>(N.getRawScope()),
1129 "local variable requires a valid scope", &N, N.getRawScope());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001130}
1131
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001132void Verifier::visitDIExpression(const DIExpression &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001133 AssertDI(N.isValid(), "invalid expression", &N);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001134}
1135
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001136void Verifier::visitDIObjCProperty(const DIObjCProperty &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001137 AssertDI(N.getTag() == dwarf::DW_TAG_APPLE_property, "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001138 if (auto *T = N.getRawType())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001139 AssertDI(isType(T), "invalid type ref", &N, T);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001140 if (auto *F = N.getRawFile())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001141 AssertDI(isa<DIFile>(F), "invalid file", &N, F);
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001142}
1143
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00001144void Verifier::visitDIImportedEntity(const DIImportedEntity &N) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00001145 AssertDI(N.getTag() == dwarf::DW_TAG_imported_module ||
1146 N.getTag() == dwarf::DW_TAG_imported_declaration,
1147 "invalid tag", &N);
Duncan P. N. Exon Smithf9b47752015-03-30 17:21:38 +00001148 if (auto *S = N.getRawScope())
Adrian Prantl541a9c52016-05-06 19:26:47 +00001149 AssertDI(isa<DIScope>(S), "invalid scope for imported entity", &N, S);
1150 AssertDI(isDINode(N.getRawEntity()), "invalid imported entity", &N,
1151 N.getRawEntity());
Duncan P. N. Exon Smithe4725be2015-02-10 01:40:40 +00001152}
Duncan P. N. Exon Smithb0a19ad2015-02-10 01:09:50 +00001153
David Majnemerdad0a642014-06-27 18:19:56 +00001154void Verifier::visitComdat(const Comdat &C) {
David Majnemerebc74112014-07-13 04:56:11 +00001155 // The Module is invalid if the GlobalValue has private linkage. Entities
1156 // with private linkage don't have entries in the symbol table.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001157 if (const GlobalValue *GV = M.getNamedValue(C.getName()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001158 Assert(!GV->hasPrivateLinkage(), "comdat global value has private linkage",
1159 GV);
David Majnemerdad0a642014-06-27 18:19:56 +00001160}
1161
Chandler Carruth043949d2014-01-19 02:22:18 +00001162void Verifier::visitModuleIdents(const Module &M) {
Rafael Espindola0018a592013-10-16 01:49:05 +00001163 const NamedMDNode *Idents = M.getNamedMetadata("llvm.ident");
1164 if (!Idents)
1165 return;
1166
1167 // llvm.ident takes a list of metadata entry. Each entry has only one string.
1168 // Scan each llvm.ident entry and make sure that this requirement is met.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001169 for (const MDNode *N : Idents->operands()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001170 Assert(N->getNumOperands() == 1,
1171 "incorrect number of operands in llvm.ident metadata", N);
1172 Assert(dyn_cast_or_null<MDString>(N->getOperand(0)),
1173 ("invalid value for llvm.ident metadata entry operand"
1174 "(the operand should be a string)"),
1175 N->getOperand(0));
Rafael Espindola0018a592013-10-16 01:49:05 +00001176 }
1177}
1178
Chandler Carruth043949d2014-01-19 02:22:18 +00001179void Verifier::visitModuleFlags(const Module &M) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001180 const NamedMDNode *Flags = M.getModuleFlagsMetadata();
1181 if (!Flags) return;
1182
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001183 // Scan each flag, and track the flags and requirements.
Chandler Carruth043949d2014-01-19 02:22:18 +00001184 DenseMap<const MDString*, const MDNode*> SeenIDs;
1185 SmallVector<const MDNode*, 16> Requirements;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001186 for (const MDNode *MDN : Flags->operands())
1187 visitModuleFlag(MDN, SeenIDs, Requirements);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001188
1189 // Validate that the requirements in the module are valid.
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001190 for (const MDNode *Requirement : Requirements) {
Chandler Carruth043949d2014-01-19 02:22:18 +00001191 const MDString *Flag = cast<MDString>(Requirement->getOperand(0));
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00001192 const Metadata *ReqValue = Requirement->getOperand(1);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001193
Chandler Carruth043949d2014-01-19 02:22:18 +00001194 const MDNode *Op = SeenIDs.lookup(Flag);
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001195 if (!Op) {
1196 CheckFailed("invalid requirement on flag, flag is not present in module",
1197 Flag);
1198 continue;
1199 }
1200
1201 if (Op->getOperand(2) != ReqValue) {
1202 CheckFailed(("invalid requirement on flag, "
1203 "flag does not have the required value"),
1204 Flag);
1205 continue;
1206 }
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001207 }
1208}
1209
Chandler Carruth043949d2014-01-19 02:22:18 +00001210void
1211Verifier::visitModuleFlag(const MDNode *Op,
1212 DenseMap<const MDString *, const MDNode *> &SeenIDs,
1213 SmallVectorImpl<const MDNode *> &Requirements) {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001214 // Each module flag should have three arguments, the merge behavior (a
1215 // constant int), the flag ID (an MDString), and the value.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001216 Assert(Op->getNumOperands() == 3,
1217 "incorrect number of operands in module flag", Op);
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001218 Module::ModFlagBehavior MFB;
1219 if (!Module::isValidModFlagBehavior(Op->getOperand(0), MFB)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001220 Assert(
David Majnemerd7677e72015-02-11 09:13:06 +00001221 mdconst::dyn_extract_or_null<ConstantInt>(Op->getOperand(0)),
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001222 "invalid behavior operand in module flag (expected constant integer)",
1223 Op->getOperand(0));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001224 Assert(false,
1225 "invalid behavior operand in module flag (unexpected constant)",
1226 Op->getOperand(0));
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001227 }
David Majnemer04b4ed32015-02-16 08:14:22 +00001228 MDString *ID = dyn_cast_or_null<MDString>(Op->getOperand(1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001229 Assert(ID, "invalid ID operand in module flag (expected metadata string)",
1230 Op->getOperand(1));
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001231
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001232 // Sanity check the values for behaviors with additional requirements.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001233 switch (MFB) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001234 case Module::Error:
1235 case Module::Warning:
1236 case Module::Override:
1237 // These behavior types accept any value.
1238 break;
1239
1240 case Module::Require: {
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001241 // The value should itself be an MDNode with two operands, a flag ID (an
1242 // MDString), and a value.
1243 MDNode *Value = dyn_cast<MDNode>(Op->getOperand(2));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001244 Assert(Value && Value->getNumOperands() == 2,
1245 "invalid value for 'require' module flag (expected metadata pair)",
1246 Op->getOperand(2));
1247 Assert(isa<MDString>(Value->getOperand(0)),
1248 ("invalid value for 'require' module flag "
1249 "(first value operand should be a string)"),
1250 Value->getOperand(0));
Daniel Dunbarc36547d2013-01-15 20:52:06 +00001251
1252 // Append it to the list of requirements, to check once all module flags are
1253 // scanned.
1254 Requirements.push_back(Value);
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001255 break;
1256 }
1257
1258 case Module::Append:
1259 case Module::AppendUnique: {
1260 // These behavior types require the operand be an MDNode.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001261 Assert(isa<MDNode>(Op->getOperand(2)),
1262 "invalid value for 'append'-type module flag "
1263 "(expected a metadata node)",
1264 Op->getOperand(2));
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001265 break;
1266 }
1267 }
1268
1269 // Unless this is a "requires" flag, check the ID is unique.
Alexey Samsonovaf023ad2014-09-08 19:16:28 +00001270 if (MFB != Module::Require) {
Daniel Dunbard77d9fb2013-01-16 21:38:56 +00001271 bool Inserted = SeenIDs.insert(std::make_pair(ID, Op)).second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001272 Assert(Inserted,
1273 "module flag identifiers must be unique (or of 'require' type)", ID);
Daniel Dunbar25c4b572013-01-15 01:22:53 +00001274 }
1275}
1276
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001277void Verifier::verifyAttributeTypes(AttributeSet Attrs, unsigned Idx,
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001278 bool isFunction, const Value *V) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001279 unsigned Slot = ~0U;
1280 for (unsigned I = 0, E = Attrs.getNumSlots(); I != E; ++I)
1281 if (Attrs.getSlotIndex(I) == Idx) {
1282 Slot = I;
1283 break;
1284 }
1285
1286 assert(Slot != ~0U && "Attribute set inconsistency!");
1287
1288 for (AttributeSet::iterator I = Attrs.begin(Slot), E = Attrs.end(Slot);
1289 I != E; ++I) {
1290 if (I->isStringAttribute())
1291 continue;
1292
1293 if (I->getKindAsEnum() == Attribute::NoReturn ||
1294 I->getKindAsEnum() == Attribute::NoUnwind ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001295 I->getKindAsEnum() == Attribute::NoInline ||
1296 I->getKindAsEnum() == Attribute::AlwaysInline ||
1297 I->getKindAsEnum() == Attribute::OptimizeForSize ||
1298 I->getKindAsEnum() == Attribute::StackProtect ||
1299 I->getKindAsEnum() == Attribute::StackProtectReq ||
1300 I->getKindAsEnum() == Attribute::StackProtectStrong ||
Peter Collingbourne82437bf2015-06-15 21:07:11 +00001301 I->getKindAsEnum() == Attribute::SafeStack ||
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001302 I->getKindAsEnum() == Attribute::NoRedZone ||
1303 I->getKindAsEnum() == Attribute::NoImplicitFloat ||
1304 I->getKindAsEnum() == Attribute::Naked ||
1305 I->getKindAsEnum() == Attribute::InlineHint ||
1306 I->getKindAsEnum() == Attribute::StackAlignment ||
1307 I->getKindAsEnum() == Attribute::UWTable ||
1308 I->getKindAsEnum() == Attribute::NonLazyBind ||
1309 I->getKindAsEnum() == Attribute::ReturnsTwice ||
1310 I->getKindAsEnum() == Attribute::SanitizeAddress ||
1311 I->getKindAsEnum() == Attribute::SanitizeThread ||
1312 I->getKindAsEnum() == Attribute::SanitizeMemory ||
1313 I->getKindAsEnum() == Attribute::MinSize ||
1314 I->getKindAsEnum() == Attribute::NoDuplicate ||
Michael Gottesman41748d72013-06-27 00:25:01 +00001315 I->getKindAsEnum() == Attribute::Builtin ||
Diego Novilloc6399532013-05-24 12:26:52 +00001316 I->getKindAsEnum() == Attribute::NoBuiltin ||
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001317 I->getKindAsEnum() == Attribute::Cold ||
Tom Roeder44cb65f2014-06-05 19:29:43 +00001318 I->getKindAsEnum() == Attribute::OptimizeNone ||
Owen Anderson85fa7d52015-05-26 23:48:40 +00001319 I->getKindAsEnum() == Attribute::JumpTable ||
Igor Laevsky39d662f2015-07-11 10:30:36 +00001320 I->getKindAsEnum() == Attribute::Convergent ||
James Molloye6f87ca2015-11-06 10:32:53 +00001321 I->getKindAsEnum() == Attribute::ArgMemOnly ||
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001322 I->getKindAsEnum() == Attribute::NoRecurse ||
1323 I->getKindAsEnum() == Attribute::InaccessibleMemOnly ||
George Burgess IV278199f2016-04-12 01:05:35 +00001324 I->getKindAsEnum() == Attribute::InaccessibleMemOrArgMemOnly ||
1325 I->getKindAsEnum() == Attribute::AllocSize) {
Tobias Grossereffd02c2013-07-02 03:28:10 +00001326 if (!isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001327 CheckFailed("Attribute '" + I->getAsString() +
1328 "' only applies to functions!", V);
1329 return;
1330 }
1331 } else if (I->getKindAsEnum() == Attribute::ReadOnly ||
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001332 I->getKindAsEnum() == Attribute::WriteOnly ||
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001333 I->getKindAsEnum() == Attribute::ReadNone) {
1334 if (Idx == 0) {
1335 CheckFailed("Attribute '" + I->getAsString() +
1336 "' does not apply to function returns");
1337 return;
Tobias Grossereffd02c2013-07-02 03:28:10 +00001338 }
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001339 } else if (isFunction) {
Nick Lewyckyc2ec0722013-07-06 00:29:58 +00001340 CheckFailed("Attribute '" + I->getAsString() +
1341 "' does not apply to functions!", V);
1342 return;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001343 }
1344 }
1345}
1346
Duncan Sandsc3a79922009-06-11 08:11:03 +00001347// VerifyParameterAttrs - Check the given attributes for an argument or return
Duncan Sands0009c442008-01-12 16:42:01 +00001348// value of the specified type. The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001349void Verifier::verifyParameterAttrs(AttributeSet Attrs, unsigned Idx, Type *Ty,
Duncan Sandsc3a79922009-06-11 08:11:03 +00001350 bool isReturnValue, const Value *V) {
Bill Wendlinge1835972013-01-21 23:03:18 +00001351 if (!Attrs.hasAttributes(Idx))
Duncan Sands0009c442008-01-12 16:42:01 +00001352 return;
1353
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001354 verifyAttributeTypes(Attrs, Idx, false, V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001355
Bill Wendling908126a2012-10-09 09:51:10 +00001356 if (isReturnValue)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001357 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1358 !Attrs.hasAttribute(Idx, Attribute::Nest) &&
1359 !Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1360 !Attrs.hasAttribute(Idx, Attribute::NoCapture) &&
1361 !Attrs.hasAttribute(Idx, Attribute::Returned) &&
Manman Renf46262e2016-03-29 17:37:21 +00001362 !Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
Manman Ren9bfd0d02016-04-01 21:41:15 +00001363 !Attrs.hasAttribute(Idx, Attribute::SwiftSelf) &&
1364 !Attrs.hasAttribute(Idx, Attribute::SwiftError),
Manman Renf46262e2016-03-29 17:37:21 +00001365 "Attributes 'byval', 'inalloca', 'nest', 'sret', 'nocapture', "
Manman Ren9bfd0d02016-04-01 21:41:15 +00001366 "'returned', 'swiftself', and 'swifterror' do not apply to return "
Manman Renf46262e2016-03-29 17:37:21 +00001367 "values!",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001368 V);
Duncan Sandsc3a79922009-06-11 08:11:03 +00001369
Reid Klecknera534a382013-12-19 02:14:12 +00001370 // Check for mutually incompatible attributes. Only inreg is compatible with
1371 // sret.
1372 unsigned AttrCount = 0;
1373 AttrCount += Attrs.hasAttribute(Idx, Attribute::ByVal);
1374 AttrCount += Attrs.hasAttribute(Idx, Attribute::InAlloca);
1375 AttrCount += Attrs.hasAttribute(Idx, Attribute::StructRet) ||
1376 Attrs.hasAttribute(Idx, Attribute::InReg);
1377 AttrCount += Attrs.hasAttribute(Idx, Attribute::Nest);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001378 Assert(AttrCount <= 1, "Attributes 'byval', 'inalloca', 'inreg', 'nest', "
1379 "and 'sret' are incompatible!",
1380 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001381
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001382 Assert(!(Attrs.hasAttribute(Idx, Attribute::InAlloca) &&
1383 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1384 "Attributes "
1385 "'inalloca and readonly' are incompatible!",
1386 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001387
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001388 Assert(!(Attrs.hasAttribute(Idx, Attribute::StructRet) &&
1389 Attrs.hasAttribute(Idx, Attribute::Returned)),
1390 "Attributes "
1391 "'sret and returned' are incompatible!",
1392 V);
Stephen Lin6c70dc72013-04-23 16:31:56 +00001393
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001394 Assert(!(Attrs.hasAttribute(Idx, Attribute::ZExt) &&
1395 Attrs.hasAttribute(Idx, Attribute::SExt)),
1396 "Attributes "
1397 "'zeroext and signext' are incompatible!",
1398 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001399
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001400 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1401 Attrs.hasAttribute(Idx, Attribute::ReadOnly)),
1402 "Attributes "
1403 "'readnone and readonly' are incompatible!",
1404 V);
Bill Wendling9864a652012-10-09 20:11:19 +00001405
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001406 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadNone) &&
1407 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1408 "Attributes "
1409 "'readnone and writeonly' are incompatible!",
1410 V);
1411
1412 Assert(!(Attrs.hasAttribute(Idx, Attribute::ReadOnly) &&
1413 Attrs.hasAttribute(Idx, Attribute::WriteOnly)),
1414 "Attributes "
1415 "'readonly and writeonly' are incompatible!",
1416 V);
1417
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001418 Assert(!(Attrs.hasAttribute(Idx, Attribute::NoInline) &&
1419 Attrs.hasAttribute(Idx, Attribute::AlwaysInline)),
1420 "Attributes "
1421 "'noinline and alwaysinline' are incompatible!",
1422 V);
Duncan Sands0009c442008-01-12 16:42:01 +00001423
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001424 Assert(
1425 !AttrBuilder(Attrs, Idx).overlaps(AttributeFuncs::typeIncompatible(Ty)),
1426 "Wrong types for attribute: " +
1427 AttributeSet::get(Context, Idx, AttributeFuncs::typeIncompatible(Ty))
1428 .getAsString(Idx),
1429 V);
Dan Gohman6d618722008-08-27 14:48:06 +00001430
Reid Klecknera534a382013-12-19 02:14:12 +00001431 if (PointerType *PTy = dyn_cast<PointerType>(Ty)) {
Craig Toppere3dcce92015-08-01 22:20:21 +00001432 SmallPtrSet<Type*, 4> Visited;
Owen Anderson08f46e12015-03-13 06:41:26 +00001433 if (!PTy->getElementType()->isSized(&Visited)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001434 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal) &&
1435 !Attrs.hasAttribute(Idx, Attribute::InAlloca),
1436 "Attributes 'byval' and 'inalloca' do not support unsized types!",
1437 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001438 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001439 if (!isa<PointerType>(PTy->getElementType()))
1440 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1441 "Attribute 'swifterror' only applies to parameters "
1442 "with pointer to pointer type!",
1443 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001444 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001445 Assert(!Attrs.hasAttribute(Idx, Attribute::ByVal),
1446 "Attribute 'byval' only applies to parameters with pointer type!",
1447 V);
Manman Ren9bfd0d02016-04-01 21:41:15 +00001448 Assert(!Attrs.hasAttribute(Idx, Attribute::SwiftError),
1449 "Attribute 'swifterror' only applies to parameters "
1450 "with pointer type!",
1451 V);
Reid Klecknera534a382013-12-19 02:14:12 +00001452 }
Duncan Sands0009c442008-01-12 16:42:01 +00001453}
1454
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001455// Check parameter attributes against a function type.
Duncan Sands8c582282007-12-21 19:19:01 +00001456// The value V is printed in error messages.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001457void Verifier::verifyFunctionAttrs(FunctionType *FT, AttributeSet Attrs,
Duncan Sands0009c442008-01-12 16:42:01 +00001458 const Value *V) {
Chris Lattner8a923e72008-03-12 17:45:29 +00001459 if (Attrs.isEmpty())
Duncan Sands8c582282007-12-21 19:19:01 +00001460 return;
1461
Duncan Sands8c582282007-12-21 19:19:01 +00001462 bool SawNest = false;
Stephen Linb8bd2322013-04-20 05:14:40 +00001463 bool SawReturned = false;
Reid Kleckner79418562014-05-09 22:32:13 +00001464 bool SawSRet = false;
Manman Renf46262e2016-03-29 17:37:21 +00001465 bool SawSwiftSelf = false;
Manman Ren9bfd0d02016-04-01 21:41:15 +00001466 bool SawSwiftError = false;
Duncan Sands8c582282007-12-21 19:19:01 +00001467
Chris Lattner8a923e72008-03-12 17:45:29 +00001468 for (unsigned i = 0, e = Attrs.getNumSlots(); i != e; ++i) {
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001469 unsigned Idx = Attrs.getSlotIndex(i);
Duncan Sands8c582282007-12-21 19:19:01 +00001470
Chris Lattner229907c2011-07-18 04:54:35 +00001471 Type *Ty;
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001472 if (Idx == 0)
Chris Lattner8a923e72008-03-12 17:45:29 +00001473 Ty = FT->getReturnType();
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001474 else if (Idx-1 < FT->getNumParams())
1475 Ty = FT->getParamType(Idx-1);
Chris Lattner8a923e72008-03-12 17:45:29 +00001476 else
Duncan Sandsc3a79922009-06-11 08:11:03 +00001477 break; // VarArgs attributes, verified elsewhere.
1478
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001479 verifyParameterAttrs(Attrs, Idx, Ty, Idx == 0, V);
Duncan Sands8c582282007-12-21 19:19:01 +00001480
Stephen Linb8bd2322013-04-20 05:14:40 +00001481 if (Idx == 0)
1482 continue;
1483
1484 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001485 Assert(!SawNest, "More than one parameter has attribute nest!", V);
Duncan Sands8c582282007-12-21 19:19:01 +00001486 SawNest = true;
1487 }
1488
Stephen Linb8bd2322013-04-20 05:14:40 +00001489 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001490 Assert(!SawReturned, "More than one parameter has attribute returned!",
1491 V);
1492 Assert(Ty->canLosslesslyBitCastTo(FT->getReturnType()),
1493 "Incompatible "
1494 "argument and return types for 'returned' attribute",
1495 V);
Stephen Linb8bd2322013-04-20 05:14:40 +00001496 SawReturned = true;
1497 }
1498
Reid Kleckner79418562014-05-09 22:32:13 +00001499 if (Attrs.hasAttribute(Idx, Attribute::StructRet)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001500 Assert(!SawSRet, "Cannot have multiple 'sret' parameters!", V);
1501 Assert(Idx == 1 || Idx == 2,
1502 "Attribute 'sret' is not on first or second parameter!", V);
Reid Kleckner79418562014-05-09 22:32:13 +00001503 SawSRet = true;
1504 }
Reid Kleckner60d3a832014-01-16 22:59:24 +00001505
Manman Renf46262e2016-03-29 17:37:21 +00001506 if (Attrs.hasAttribute(Idx, Attribute::SwiftSelf)) {
1507 Assert(!SawSwiftSelf, "Cannot have multiple 'swiftself' parameters!", V);
1508 SawSwiftSelf = true;
1509 }
1510
Manman Ren9bfd0d02016-04-01 21:41:15 +00001511 if (Attrs.hasAttribute(Idx, Attribute::SwiftError)) {
1512 Assert(!SawSwiftError, "Cannot have multiple 'swifterror' parameters!",
1513 V);
1514 SawSwiftError = true;
1515 }
1516
Reid Kleckner60d3a832014-01-16 22:59:24 +00001517 if (Attrs.hasAttribute(Idx, Attribute::InAlloca)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001518 Assert(Idx == FT->getNumParams(), "inalloca isn't on the last parameter!",
1519 V);
Reid Kleckner60d3a832014-01-16 22:59:24 +00001520 }
Duncan Sands8c582282007-12-21 19:19:01 +00001521 }
Devang Patel9cc98122008-10-01 23:41:25 +00001522
Bill Wendling77543892013-01-18 21:11:39 +00001523 if (!Attrs.hasAttributes(AttributeSet::FunctionIndex))
1524 return;
1525
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001526 verifyAttributeTypes(Attrs, AttributeSet::FunctionIndex, true, V);
Bill Wendling9864a652012-10-09 20:11:19 +00001527
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001528 Assert(
1529 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1530 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly)),
1531 "Attributes 'readnone and readonly' are incompatible!", V);
Bill Wendling9864a652012-10-09 20:11:19 +00001532
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001533 Assert(
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001534 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Nicolai Haehnle84c9f992016-07-04 08:01:29 +00001535 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1536 "Attributes 'readnone and writeonly' are incompatible!", V);
1537
1538 Assert(
1539 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadOnly) &&
1540 Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::WriteOnly)),
1541 "Attributes 'readonly and writeonly' are incompatible!", V);
1542
1543 Assert(
1544 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
Vaivaswatha Nagarajfb3f4902015-12-16 16:16:19 +00001545 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1546 Attribute::InaccessibleMemOrArgMemOnly)),
1547 "Attributes 'readnone and inaccessiblemem_or_argmemonly' are incompatible!", V);
1548
1549 Assert(
1550 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::ReadNone) &&
1551 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1552 Attribute::InaccessibleMemOnly)),
1553 "Attributes 'readnone and inaccessiblememonly' are incompatible!", V);
1554
1555 Assert(
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001556 !(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline) &&
1557 Attrs.hasAttribute(AttributeSet::FunctionIndex,
1558 Attribute::AlwaysInline)),
1559 "Attributes 'noinline and alwaysinline' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001560
1561 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1562 Attribute::OptimizeNone)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001563 Assert(Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::NoInline),
1564 "Attribute 'optnone' requires 'noinline'!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001565
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001566 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex,
1567 Attribute::OptimizeForSize),
1568 "Attributes 'optsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001569
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001570 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::MinSize),
1571 "Attributes 'minsize and optnone' are incompatible!", V);
Andrea Di Biagio377496b2013-08-23 11:53:55 +00001572 }
Tom Roeder44cb65f2014-06-05 19:29:43 +00001573
1574 if (Attrs.hasAttribute(AttributeSet::FunctionIndex,
1575 Attribute::JumpTable)) {
1576 const GlobalValue *GV = cast<GlobalValue>(V);
Peter Collingbourne96efdd62016-06-14 21:01:22 +00001577 Assert(GV->hasGlobalUnnamedAddr(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001578 "Attribute 'jumptable' requires 'unnamed_addr'", V);
Tom Roeder44cb65f2014-06-05 19:29:43 +00001579 }
George Burgess IV278199f2016-04-12 01:05:35 +00001580
1581 if (Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::AllocSize)) {
1582 std::pair<unsigned, Optional<unsigned>> Args =
1583 Attrs.getAllocSizeArgs(AttributeSet::FunctionIndex);
1584
1585 auto CheckParam = [&](StringRef Name, unsigned ParamNo) {
1586 if (ParamNo >= FT->getNumParams()) {
1587 CheckFailed("'allocsize' " + Name + " argument is out of bounds", V);
1588 return false;
1589 }
1590
1591 if (!FT->getParamType(ParamNo)->isIntegerTy()) {
1592 CheckFailed("'allocsize' " + Name +
1593 " argument must refer to an integer parameter",
1594 V);
1595 return false;
1596 }
1597
1598 return true;
1599 };
1600
1601 if (!CheckParam("element size", Args.first))
1602 return;
1603
1604 if (Args.second && !CheckParam("number of elements", *Args.second))
1605 return;
1606 }
Duncan Sands8c582282007-12-21 19:19:01 +00001607}
1608
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001609void Verifier::verifyFunctionMetadata(
Benjamin Kramer7ab4fe32016-06-12 17:46:23 +00001610 ArrayRef<std::pair<unsigned, MDNode *>> MDs) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001611 for (const auto &Pair : MDs) {
1612 if (Pair.first == LLVMContext::MD_prof) {
1613 MDNode *MD = Pair.second;
Diego Novillo2567f3d2015-05-13 15:13:45 +00001614 Assert(MD->getNumOperands() == 2,
1615 "!prof annotations should have exactly 2 operands", MD);
1616
1617 // Check first operand.
1618 Assert(MD->getOperand(0) != nullptr, "first operand should not be null",
1619 MD);
1620 Assert(isa<MDString>(MD->getOperand(0)),
1621 "expected string with name of the !prof annotation", MD);
1622 MDString *MDS = cast<MDString>(MD->getOperand(0));
1623 StringRef ProfName = MDS->getString();
1624 Assert(ProfName.equals("function_entry_count"),
1625 "first operand should be 'function_entry_count'", MD);
1626
1627 // Check second operand.
1628 Assert(MD->getOperand(1) != nullptr, "second operand should not be null",
1629 MD);
1630 Assert(isa<ConstantAsMetadata>(MD->getOperand(1)),
1631 "expected integer argument to function_entry_count", MD);
1632 }
1633 }
1634}
1635
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001636void Verifier::visitConstantExprsRecursively(const Constant *EntryC) {
1637 if (!ConstantExprVisited.insert(EntryC).second)
1638 return;
1639
1640 SmallVector<const Constant *, 16> Stack;
1641 Stack.push_back(EntryC);
1642
1643 while (!Stack.empty()) {
1644 const Constant *C = Stack.pop_back_val();
1645
1646 // Check this constant expression.
1647 if (const auto *CE = dyn_cast<ConstantExpr>(C))
1648 visitConstantExpr(CE);
1649
Keno Fischerf6d17b92016-01-14 22:42:02 +00001650 if (const auto *GV = dyn_cast<GlobalValue>(C)) {
1651 // Global Values get visited separately, but we do need to make sure
1652 // that the global value is in the correct module
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001653 Assert(GV->getParent() == &M, "Referencing global in another module!",
1654 EntryC, &M, GV, GV->getParent());
Keno Fischerf6d17b92016-01-14 22:42:02 +00001655 continue;
1656 }
1657
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001658 // Visit all sub-expressions.
1659 for (const Use &U : C->operands()) {
1660 const auto *OpC = dyn_cast<Constant>(U);
1661 if (!OpC)
1662 continue;
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00001663 if (!ConstantExprVisited.insert(OpC).second)
1664 continue;
1665 Stack.push_back(OpC);
1666 }
1667 }
1668}
1669
1670void Verifier::visitConstantExpr(const ConstantExpr *CE) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001671 if (CE->getOpcode() == Instruction::BitCast)
1672 Assert(CastInst::castIsValid(Instruction::BitCast, CE->getOperand(0),
1673 CE->getType()),
1674 "Invalid bitcast", CE);
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00001675
Sanjoy Dase1129ee2016-08-02 02:55:57 +00001676 if (CE->getOpcode() == Instruction::IntToPtr ||
1677 CE->getOpcode() == Instruction::PtrToInt) {
1678 auto *PtrTy = CE->getOpcode() == Instruction::IntToPtr
1679 ? CE->getType()
1680 : CE->getOperand(0)->getType();
1681 StringRef Msg = CE->getOpcode() == Instruction::IntToPtr
1682 ? "inttoptr not supported for non-integral pointers"
1683 : "ptrtoint not supported for non-integral pointers";
1684 Assert(
1685 !DL.isNonIntegralPointerType(cast<PointerType>(PtrTy->getScalarType())),
1686 Msg);
1687 }
Matt Arsenault24b49c42013-07-31 17:49:08 +00001688}
1689
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001690bool Verifier::verifyAttributeCount(AttributeSet Attrs, unsigned Params) {
Bill Wendling0aed1132013-01-30 06:54:41 +00001691 if (Attrs.getNumSlots() == 0)
Devang Patel82fed672008-09-23 22:35:17 +00001692 return true;
Nick Lewycky3fc89802009-09-07 20:44:51 +00001693
Devang Patel82fed672008-09-23 22:35:17 +00001694 unsigned LastSlot = Attrs.getNumSlots() - 1;
Bill Wendling25e65a62013-01-25 21:30:53 +00001695 unsigned LastIndex = Attrs.getSlotIndex(LastSlot);
Devang Patel82fed672008-09-23 22:35:17 +00001696 if (LastIndex <= Params
Bill Wendling25e65a62013-01-25 21:30:53 +00001697 || (LastIndex == AttributeSet::FunctionIndex
1698 && (LastSlot == 0 || Attrs.getSlotIndex(LastSlot - 1) <= Params)))
Devang Patel82fed672008-09-23 22:35:17 +00001699 return true;
Matt Arsenaultc4c92262013-07-20 17:46:00 +00001700
Devang Patel82fed672008-09-23 22:35:17 +00001701 return false;
1702}
Nick Lewycky3fc89802009-09-07 20:44:51 +00001703
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001704/// Verify that statepoint intrinsic is well formed.
1705void Verifier::verifyStatepoint(ImmutableCallSite CS) {
Philip Reames0285c742015-02-03 23:18:47 +00001706 assert(CS.getCalledFunction() &&
1707 CS.getCalledFunction()->getIntrinsicID() ==
1708 Intrinsic::experimental_gc_statepoint);
Philip Reames1ffa9372015-01-30 23:28:05 +00001709
Philip Reames0285c742015-02-03 23:18:47 +00001710 const Instruction &CI = *CS.getInstruction();
1711
Igor Laevsky39d662f2015-07-11 10:30:36 +00001712 Assert(!CS.doesNotAccessMemory() && !CS.onlyReadsMemory() &&
1713 !CS.onlyAccessesArgMemory(),
1714 "gc.statepoint must read and write all memory to preserve "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001715 "reordering restrictions required by safepoint semantics",
1716 &CI);
1717
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001718 const Value *IDV = CS.getArgument(0);
1719 Assert(isa<ConstantInt>(IDV), "gc.statepoint ID must be a constant integer",
1720 &CI);
1721
1722 const Value *NumPatchBytesV = CS.getArgument(1);
1723 Assert(isa<ConstantInt>(NumPatchBytesV),
1724 "gc.statepoint number of patchable bytes must be a constant integer",
1725 &CI);
Sanjoy Das9af34eb2015-05-13 20:11:59 +00001726 const int64_t NumPatchBytes =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001727 cast<ConstantInt>(NumPatchBytesV)->getSExtValue();
1728 assert(isInt<32>(NumPatchBytes) && "NumPatchBytesV is an i32!");
1729 Assert(NumPatchBytes >= 0, "gc.statepoint number of patchable bytes must be "
1730 "positive",
1731 &CI);
1732
1733 const Value *Target = CS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00001734 auto *PT = dyn_cast<PointerType>(Target->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001735 Assert(PT && PT->getElementType()->isFunctionTy(),
1736 "gc.statepoint callee must be of function pointer type", &CI, Target);
Quentin Colombet3e93ebe2015-05-09 00:02:06 +00001737 FunctionType *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames1ffa9372015-01-30 23:28:05 +00001738
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001739 const Value *NumCallArgsV = CS.getArgument(3);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001740 Assert(isa<ConstantInt>(NumCallArgsV),
1741 "gc.statepoint number of arguments to underlying call "
1742 "must be constant integer",
1743 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001744 const int NumCallArgs = cast<ConstantInt>(NumCallArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001745 Assert(NumCallArgs >= 0,
1746 "gc.statepoint number of arguments to underlying call "
1747 "must be positive",
1748 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001749 const int NumParams = (int)TargetFuncType->getNumParams();
1750 if (TargetFuncType->isVarArg()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001751 Assert(NumCallArgs >= NumParams,
1752 "gc.statepoint mismatch in number of vararg call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001753
1754 // TODO: Remove this limitation
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001755 Assert(TargetFuncType->getReturnType()->isVoidTy(),
1756 "gc.statepoint doesn't support wrapping non-void "
1757 "vararg functions yet",
1758 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001759 } else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001760 Assert(NumCallArgs == NumParams,
1761 "gc.statepoint mismatch in number of call args", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001762
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001763 const Value *FlagsV = CS.getArgument(4);
Pat Gavlincc0431d2015-05-08 18:07:42 +00001764 Assert(isa<ConstantInt>(FlagsV),
1765 "gc.statepoint flags must be constant integer", &CI);
1766 const uint64_t Flags = cast<ConstantInt>(FlagsV)->getZExtValue();
1767 Assert((Flags & ~(uint64_t)StatepointFlags::MaskAll) == 0,
1768 "unknown flag used in gc.statepoint flags argument", &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001769
1770 // Verify that the types of the call parameter arguments match
1771 // the type of the wrapped callee.
1772 for (int i = 0; i < NumParams; i++) {
1773 Type *ParamType = TargetFuncType->getParamType(i);
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001774 Type *ArgType = CS.getArgument(5 + i)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001775 Assert(ArgType == ParamType,
1776 "gc.statepoint call argument does not match wrapped "
1777 "function type",
1778 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001779 }
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001780
1781 const int EndCallArgsInx = 4 + NumCallArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001782
1783 const Value *NumTransitionArgsV = CS.getArgument(EndCallArgsInx+1);
1784 Assert(isa<ConstantInt>(NumTransitionArgsV),
1785 "gc.statepoint number of transition arguments "
1786 "must be constant integer",
1787 &CI);
1788 const int NumTransitionArgs =
1789 cast<ConstantInt>(NumTransitionArgsV)->getZExtValue();
1790 Assert(NumTransitionArgs >= 0,
1791 "gc.statepoint number of transition arguments must be positive", &CI);
1792 const int EndTransitionArgsInx = EndCallArgsInx + 1 + NumTransitionArgs;
1793
1794 const Value *NumDeoptArgsV = CS.getArgument(EndTransitionArgsInx+1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001795 Assert(isa<ConstantInt>(NumDeoptArgsV),
1796 "gc.statepoint number of deoptimization arguments "
1797 "must be constant integer",
1798 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001799 const int NumDeoptArgs = cast<ConstantInt>(NumDeoptArgsV)->getZExtValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001800 Assert(NumDeoptArgs >= 0, "gc.statepoint number of deoptimization arguments "
1801 "must be positive",
1802 &CI);
Philip Reames1ffa9372015-01-30 23:28:05 +00001803
Pat Gavlincc0431d2015-05-08 18:07:42 +00001804 const int ExpectedNumArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00001805 7 + NumCallArgs + NumTransitionArgs + NumDeoptArgs;
Pat Gavlincc0431d2015-05-08 18:07:42 +00001806 Assert(ExpectedNumArgs <= (int)CS.arg_size(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001807 "gc.statepoint too few arguments according to length fields", &CI);
1808
Philip Reames1ffa9372015-01-30 23:28:05 +00001809 // Check that the only uses of this gc.statepoint are gc.result or
1810 // gc.relocate calls which are tied to this statepoint and thus part
1811 // of the same statepoint sequence
Philip Reames0285c742015-02-03 23:18:47 +00001812 for (const User *U : CI.users()) {
Philip Reames1ffa9372015-01-30 23:28:05 +00001813 const CallInst *Call = dyn_cast<const CallInst>(U);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001814 Assert(Call, "illegal use of statepoint token", &CI, U);
Philip Reames1ffa9372015-01-30 23:28:05 +00001815 if (!Call) continue;
Philip Reames92d1f0c2016-04-12 18:05:10 +00001816 Assert(isa<GCRelocateInst>(Call) || isa<GCResultInst>(Call),
Sanjoy Das25fb5bd2016-08-11 00:56:46 +00001817 "gc.result or gc.relocate are the only value uses "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001818 "of a gc.statepoint",
1819 &CI, U);
Philip Reames92d1f0c2016-04-12 18:05:10 +00001820 if (isa<GCResultInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001821 Assert(Call->getArgOperand(0) == &CI,
1822 "gc.result connected to wrong gc.statepoint", &CI, Call);
Manuel Jacob83eefa62016-01-05 04:03:00 +00001823 } else if (isa<GCRelocateInst>(Call)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001824 Assert(Call->getArgOperand(0) == &CI,
1825 "gc.relocate connected to wrong gc.statepoint", &CI, Call);
Philip Reames1ffa9372015-01-30 23:28:05 +00001826 }
1827 }
1828
1829 // Note: It is legal for a single derived pointer to be listed multiple
1830 // times. It's non-optimal, but it is legal. It can also happen after
1831 // insertion if we strip a bitcast away.
1832 // Note: It is really tempting to check that each base is relocated and
1833 // that a derived pointer is never reused as a base pointer. This turns
1834 // out to be problematic since optimizations run after safepoint insertion
1835 // can recognize equality properties that the insertion logic doesn't know
1836 // about. See example statepoint.ll in the verifier subdirectory
1837}
1838
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001839void Verifier::verifyFrameRecoverIndices() {
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001840 for (auto &Counts : FrameEscapeInfo) {
1841 Function *F = Counts.first;
1842 unsigned EscapedObjectCount = Counts.second.first;
1843 unsigned MaxRecoveredIndex = Counts.second.second;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001844 Assert(MaxRecoveredIndex <= EscapedObjectCount,
Reid Kleckner60381792015-07-07 22:25:32 +00001845 "all indices passed to llvm.localrecover must be less than the "
1846 "number of arguments passed ot llvm.localescape in the parent "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001847 "function",
1848 F);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00001849 }
1850}
1851
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00001852static Instruction *getSuccPad(TerminatorInst *Terminator) {
1853 BasicBlock *UnwindDest;
1854 if (auto *II = dyn_cast<InvokeInst>(Terminator))
1855 UnwindDest = II->getUnwindDest();
1856 else if (auto *CSI = dyn_cast<CatchSwitchInst>(Terminator))
1857 UnwindDest = CSI->getUnwindDest();
1858 else
1859 UnwindDest = cast<CleanupReturnInst>(Terminator)->getUnwindDest();
1860 return UnwindDest->getFirstNonPHI();
1861}
1862
1863void Verifier::verifySiblingFuncletUnwinds() {
1864 SmallPtrSet<Instruction *, 8> Visited;
1865 SmallPtrSet<Instruction *, 8> Active;
1866 for (const auto &Pair : SiblingFuncletInfo) {
1867 Instruction *PredPad = Pair.first;
1868 if (Visited.count(PredPad))
1869 continue;
1870 Active.insert(PredPad);
1871 TerminatorInst *Terminator = Pair.second;
1872 do {
1873 Instruction *SuccPad = getSuccPad(Terminator);
1874 if (Active.count(SuccPad)) {
1875 // Found a cycle; report error
1876 Instruction *CyclePad = SuccPad;
1877 SmallVector<Instruction *, 8> CycleNodes;
1878 do {
1879 CycleNodes.push_back(CyclePad);
1880 TerminatorInst *CycleTerminator = SiblingFuncletInfo[CyclePad];
1881 if (CycleTerminator != CyclePad)
1882 CycleNodes.push_back(CycleTerminator);
1883 CyclePad = getSuccPad(CycleTerminator);
1884 } while (CyclePad != SuccPad);
1885 Assert(false, "EH pads can't handle each other's exceptions",
1886 ArrayRef<Instruction *>(CycleNodes));
1887 }
1888 // Don't re-walk a node we've already checked
1889 if (!Visited.insert(SuccPad).second)
1890 break;
1891 // Walk to this successor if it has a map entry.
1892 PredPad = SuccPad;
1893 auto TermI = SiblingFuncletInfo.find(PredPad);
1894 if (TermI == SiblingFuncletInfo.end())
1895 break;
1896 Terminator = TermI->second;
1897 Active.insert(PredPad);
1898 } while (true);
1899 // Each node only has one successor, so we've walked all the active
1900 // nodes' successors.
1901 Active.clear();
1902 }
1903}
1904
Chris Lattner0e851da2002-04-18 20:37:37 +00001905// visitFunction - Verify that a function is ok.
Chris Lattnerd02f08d2002-02-20 17:55:43 +00001906//
Chandler Carruth043949d2014-01-19 02:22:18 +00001907void Verifier::visitFunction(const Function &F) {
Peter Collingbournebb738172016-06-06 23:21:27 +00001908 visitGlobalValue(F);
1909
Chris Lattner2ad5aa82005-05-08 22:27:09 +00001910 // Check function arguments.
Chris Lattner229907c2011-07-18 04:54:35 +00001911 FunctionType *FT = F.getFunctionType();
Chris Lattner45ffa212007-08-18 06:13:19 +00001912 unsigned NumArgs = F.arg_size();
Chris Lattneraf95e582002-04-13 22:48:46 +00001913
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00001914 Assert(&Context == &F.getContext(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001915 "Function context does not match Module context!", &F);
Nick Lewycky62f864d2010-02-15 21:52:04 +00001916
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001917 Assert(!F.hasCommonLinkage(), "Functions may not have common linkage", &F);
1918 Assert(FT->getNumParams() == NumArgs,
1919 "# formal arguments must match # of arguments for function type!", &F,
1920 FT);
1921 Assert(F.getReturnType()->isFirstClassType() ||
1922 F.getReturnType()->isVoidTy() || F.getReturnType()->isStructTy(),
1923 "Functions cannot return aggregate values!", &F);
Chris Lattneraf95e582002-04-13 22:48:46 +00001924
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001925 Assert(!F.hasStructRetAttr() || F.getReturnType()->isVoidTy(),
1926 "Invalid struct return type!", &F);
Devang Patel9d9178592008-03-03 21:46:28 +00001927
Bill Wendlinge3a60a92013-04-18 20:15:25 +00001928 AttributeSet Attrs = F.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001929
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001930 Assert(verifyAttributeCount(Attrs, FT->getNumParams()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001931 "Attribute after last parameter!", &F);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00001932
Duncan Sands8c582282007-12-21 19:19:01 +00001933 // Check function attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001934 verifyFunctionAttrs(FT, Attrs, &F);
Duncan Sands07c90662007-07-27 15:09:54 +00001935
Michael Gottesman41748d72013-06-27 00:25:01 +00001936 // On function declarations/definitions, we do not support the builtin
1937 // attribute. We do not check this in VerifyFunctionAttrs since that is
1938 // checking for Attributes that can/can not ever be on functions.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001939 Assert(!Attrs.hasAttribute(AttributeSet::FunctionIndex, Attribute::Builtin),
1940 "Attribute 'builtin' can only be applied to a callsite.", &F);
Michael Gottesman41748d72013-06-27 00:25:01 +00001941
Chris Lattneref13ee32006-05-19 21:25:17 +00001942 // Check that this function meets the restrictions on this calling convention.
Reid Kleckner329d4a22014-08-29 21:25:28 +00001943 // Sometimes varargs is used for perfectly forwarding thunks, so some of these
1944 // restrictions can be lifted.
Chris Lattneref13ee32006-05-19 21:25:17 +00001945 switch (F.getCallingConv()) {
1946 default:
Chris Lattneref13ee32006-05-19 21:25:17 +00001947 case CallingConv::C:
1948 break;
Chris Lattneref13ee32006-05-19 21:25:17 +00001949 case CallingConv::Fast:
1950 case CallingConv::Cold:
Elena Demikhovskyd6afb032012-10-24 14:46:16 +00001951 case CallingConv::Intel_OCL_BI:
Che-Liang Chiou29947902010-09-25 07:46:17 +00001952 case CallingConv::PTX_Kernel:
1953 case CallingConv::PTX_Device:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001954 Assert(!F.isVarArg(), "Calling convention does not support varargs or "
1955 "perfect forwarding!",
1956 &F);
Chris Lattneref13ee32006-05-19 21:25:17 +00001957 break;
1958 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00001959
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001960 bool isLLVMdotName = F.getName().size() >= 5 &&
1961 F.getName().substr(0, 5) == "llvm.";
Nick Lewyckyadbc2842009-05-30 05:06:04 +00001962
Chris Lattneraf95e582002-04-13 22:48:46 +00001963 // Check that the argument values match the function type for this function...
Chris Lattner149376d2002-10-13 20:57:00 +00001964 unsigned i = 0;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001965 for (const Argument &Arg : F.args()) {
1966 Assert(Arg.getType() == FT->getParamType(i),
1967 "Argument value does not match function argument type!", &Arg,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00001968 FT->getParamType(i));
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001969 Assert(Arg.getType()->isFirstClassType(),
1970 "Function arguments must have first-class types!", &Arg);
David Majnemerb611e3f2015-08-14 05:09:07 +00001971 if (!isLLVMdotName) {
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001972 Assert(!Arg.getType()->isMetadataTy(),
1973 "Function takes metadata but isn't an intrinsic", &Arg, &F);
1974 Assert(!Arg.getType()->isTokenTy(),
1975 "Function takes token but isn't an intrinsic", &Arg, &F);
David Majnemerb611e3f2015-08-14 05:09:07 +00001976 }
Manman Ren9bfd0d02016-04-01 21:41:15 +00001977
1978 // Check that swifterror argument is only used by loads and stores.
1979 if (Attrs.hasAttribute(i+1, Attribute::SwiftError)) {
1980 verifySwiftErrorValue(&Arg);
1981 }
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00001982 ++i;
Dan Gohman4051bf42008-08-27 14:44:57 +00001983 }
Chris Lattneraf95e582002-04-13 22:48:46 +00001984
David Majnemerb611e3f2015-08-14 05:09:07 +00001985 if (!isLLVMdotName)
1986 Assert(!F.getReturnType()->isTokenTy(),
1987 "Functions returns a token but isn't an intrinsic", &F);
1988
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001989 // Get the function metadata attachments.
1990 SmallVector<std::pair<unsigned, MDNode *>, 4> MDs;
1991 F.getAllMetadata(MDs);
1992 assert(F.hasMetadata() != MDs.empty() && "Bit out-of-sync");
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00001993 verifyFunctionMetadata(MDs);
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00001994
Keno Fischer2ac0c272015-11-16 05:13:30 +00001995 // Check validity of the personality function
1996 if (F.hasPersonalityFn()) {
1997 auto *Per = dyn_cast<Function>(F.getPersonalityFn()->stripPointerCasts());
1998 if (Per)
1999 Assert(Per->getParent() == F.getParent(),
Keno Fischera6c4ce42015-12-01 19:06:36 +00002000 "Referencing personality function in another module!",
2001 &F, F.getParent(), Per, Per->getParent());
Keno Fischer2ac0c272015-11-16 05:13:30 +00002002 }
2003
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002004 if (F.isMaterializable()) {
2005 // Function has a body somewhere we can't see.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002006 Assert(MDs.empty(), "unmaterialized function cannot have metadata", &F,
2007 MDs.empty() ? nullptr : MDs.front().second);
Jeffrey Yasskin091217b2010-01-27 20:34:15 +00002008 } else if (F.isDeclaration()) {
Peter Collingbourne21521892016-06-21 23:42:48 +00002009 for (const auto &I : MDs) {
2010 AssertDI(I.first != LLVMContext::MD_dbg,
2011 "function declaration may not have a !dbg attachment", &F);
2012 Assert(I.first != LLVMContext::MD_prof,
2013 "function declaration may not have a !prof attachment", &F);
2014
2015 // Verify the metadata itself.
2016 visitMDNode(*I.second);
2017 }
David Majnemer7fddecc2015-06-17 20:52:32 +00002018 Assert(!F.hasPersonalityFn(),
2019 "Function declaration shouldn't have a personality routine", &F);
Chris Lattnerd79f3d52007-09-19 17:14:45 +00002020 } else {
Chris Lattnercb813312006-12-13 04:45:46 +00002021 // Verify that this function (which has a body) is not named "llvm.*". It
2022 // is not legal to define intrinsics.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002023 Assert(!isLLVMdotName, "llvm intrinsics cannot be defined!", &F);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002024
Chris Lattner149376d2002-10-13 20:57:00 +00002025 // Check the entry node
Chandler Carruth043949d2014-01-19 02:22:18 +00002026 const BasicBlock *Entry = &F.getEntryBlock();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002027 Assert(pred_empty(Entry),
2028 "Entry block to function must not have predecessors!", Entry);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002029
Chris Lattner27471742009-11-01 04:08:01 +00002030 // The address of the entry block cannot be taken, unless it is dead.
2031 if (Entry->hasAddressTaken()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002032 Assert(!BlockAddress::lookup(Entry)->isConstantUsed(),
2033 "blockaddress may not be used with the entry block!", Entry);
Chris Lattner27471742009-11-01 04:08:01 +00002034 }
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002035
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002036 unsigned NumDebugAttachments = 0, NumProfAttachments = 0;
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002037 // Visit metadata attachments.
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002038 for (const auto &I : MDs) {
2039 // Verify that the attachment is legal.
2040 switch (I.first) {
2041 default:
2042 break;
2043 case LLVMContext::MD_dbg:
Peter Collingbourne382d81c2016-06-01 01:17:57 +00002044 ++NumDebugAttachments;
2045 AssertDI(NumDebugAttachments == 1,
2046 "function must have a single !dbg attachment", &F, I.second);
Adrian Prantl541a9c52016-05-06 19:26:47 +00002047 AssertDI(isa<DISubprogram>(I.second),
2048 "function !dbg attachment must be a subprogram", &F, I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002049 break;
Peter Collingbourne6dbee002016-06-14 23:13:15 +00002050 case LLVMContext::MD_prof:
2051 ++NumProfAttachments;
2052 Assert(NumProfAttachments == 1,
2053 "function must have a single !prof attachment", &F, I.second);
2054 break;
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002055 }
2056
2057 // Verify the metadata itself.
Duncan P. N. Exon Smith327e9bd2015-04-24 21:53:27 +00002058 visitMDNode(*I.second);
Duncan P. N. Exon Smithb56b5af2015-08-28 21:55:35 +00002059 }
Chris Lattner149376d2002-10-13 20:57:00 +00002060 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002061
Chris Lattner7730dcc2009-09-11 17:05:29 +00002062 // If this function is actually an intrinsic, verify that it is only used in
2063 // direct call/invokes, never having its "address taken".
Rafael Espindola257a3532016-01-15 19:00:20 +00002064 // Only do this if the module is materialized, otherwise we don't have all the
2065 // uses.
2066 if (F.getIntrinsicID() && F.getParent()->isMaterialized()) {
Gabor Greifa2fbc0a2010-03-24 13:21:49 +00002067 const User *U;
2068 if (F.hasAddressTaken(&U))
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002069 Assert(false, "Invalid user of intrinsic instruction!", U);
Chris Lattner7730dcc2009-09-11 17:05:29 +00002070 }
Nico Rieck7157bb72014-01-14 15:22:47 +00002071
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002072 Assert(!F.hasDLLImportStorageClass() ||
2073 (F.isDeclaration() && F.hasExternalLinkage()) ||
2074 F.hasAvailableExternallyLinkage(),
2075 "Function is marked as dllimport, but not external.", &F);
Peter Collingbourned4bff302015-11-05 22:03:56 +00002076
2077 auto *N = F.getSubprogram();
2078 if (!N)
2079 return;
2080
Adrian Prantl75819ae2016-04-15 15:57:41 +00002081 visitDISubprogram(*N);
2082
Peter Collingbourned4bff302015-11-05 22:03:56 +00002083 // Check that all !dbg attachments lead to back to N (or, at least, another
2084 // subprogram that describes the same function).
2085 //
2086 // FIXME: Check this incrementally while visiting !dbg attachments.
2087 // FIXME: Only check when N is the canonical subprogram for F.
2088 SmallPtrSet<const MDNode *, 32> Seen;
2089 for (auto &BB : F)
2090 for (auto &I : BB) {
2091 // Be careful about using DILocation here since we might be dealing with
2092 // broken code (this is the Verifier after all).
2093 DILocation *DL =
2094 dyn_cast_or_null<DILocation>(I.getDebugLoc().getAsMDNode());
2095 if (!DL)
2096 continue;
2097 if (!Seen.insert(DL).second)
2098 continue;
2099
2100 DILocalScope *Scope = DL->getInlinedAtScope();
2101 if (Scope && !Seen.insert(Scope).second)
2102 continue;
2103
2104 DISubprogram *SP = Scope ? Scope->getSubprogram() : nullptr;
Keno Fischer0ef8ccf2015-12-06 23:05:38 +00002105
2106 // Scope and SP could be the same MDNode and we don't want to skip
2107 // validation in that case
2108 if (SP && ((Scope != SP) && !Seen.insert(SP).second))
Peter Collingbourned4bff302015-11-05 22:03:56 +00002109 continue;
2110
2111 // FIXME: Once N is canonical, check "SP == &N".
2112 Assert(SP->describes(&F),
2113 "!dbg attachment points at wrong subprogram for function", N, &F,
2114 &I, DL, Scope, SP);
2115 }
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002116}
2117
Chris Lattner0e851da2002-04-18 20:37:37 +00002118// verifyBasicBlock - Verify that a basic block is well formed...
2119//
Chris Lattner069a7952002-06-25 15:56:27 +00002120void Verifier::visitBasicBlock(BasicBlock &BB) {
Chris Lattnerc9e79d02004-09-29 20:07:45 +00002121 InstsInThisBlock.clear();
2122
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002123 // Ensure that basic blocks have terminators!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002124 Assert(BB.getTerminator(), "Basic Block does not have terminator!", &BB);
Alkis Evlogimenosbe526cf2004-12-04 02:30:42 +00002125
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002126 // Check constraints that this basic block imposes on all of the PHI nodes in
2127 // it.
2128 if (isa<PHINode>(BB.front())) {
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002129 SmallVector<BasicBlock*, 8> Preds(pred_begin(&BB), pred_end(&BB));
2130 SmallVector<std::pair<BasicBlock*, Value*>, 8> Values;
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002131 std::sort(Preds.begin(), Preds.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002132 PHINode *PN;
Chris Lattner307e1df2004-06-05 17:44:48 +00002133 for (BasicBlock::iterator I = BB.begin(); (PN = dyn_cast<PHINode>(I));++I) {
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002134 // Ensure that PHI nodes have at least one entry!
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002135 Assert(PN->getNumIncomingValues() != 0,
2136 "PHI nodes must have at least one entry. If the block is dead, "
2137 "the PHI should be removed!",
2138 PN);
2139 Assert(PN->getNumIncomingValues() == Preds.size(),
2140 "PHINode should have one entry for each predecessor of its "
2141 "parent basic block!",
2142 PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002143
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002144 // Get and sort all incoming values in the PHI node...
Chris Lattner59a8d2c2007-02-10 08:33:11 +00002145 Values.clear();
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002146 Values.reserve(PN->getNumIncomingValues());
2147 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
2148 Values.push_back(std::make_pair(PN->getIncomingBlock(i),
2149 PN->getIncomingValue(i)));
2150 std::sort(Values.begin(), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00002151
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002152 for (unsigned i = 0, e = Values.size(); i != e; ++i) {
2153 // Check to make sure that if there is more than one entry for a
2154 // particular basic block in this PHI node, that the incoming values are
2155 // all identical.
2156 //
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002157 Assert(i == 0 || Values[i].first != Values[i - 1].first ||
2158 Values[i].second == Values[i - 1].second,
2159 "PHI node has multiple entries for the same basic block with "
2160 "different incoming values!",
2161 PN, Values[i].first, Values[i].second, Values[i - 1].second);
Misha Brukmanb1c93172005-04-21 23:48:37 +00002162
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002163 // Check to make sure that the predecessors and PHI node entries are
2164 // matched up.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002165 Assert(Values[i].first == Preds[i],
2166 "PHI node entries do not match predecessors!", PN,
2167 Values[i].first, Preds[i]);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002168 }
2169 }
2170 }
Adrian Prantl940257f2014-11-21 00:39:43 +00002171
2172 // Check that all instructions have their parent pointers set up correctly.
Zachary Turner8325a5c2014-11-21 01:19:09 +00002173 for (auto &I : BB)
2174 {
Adrian Prantl940257f2014-11-21 00:39:43 +00002175 Assert(I.getParent() == &BB, "Instruction has bogus parent pointer!");
Zachary Turner8325a5c2014-11-21 01:19:09 +00002176 }
Chris Lattner069a7952002-06-25 15:56:27 +00002177}
Chris Lattnerfbf5be52002-03-15 20:25:09 +00002178
Chris Lattner069a7952002-06-25 15:56:27 +00002179void Verifier::visitTerminatorInst(TerminatorInst &I) {
2180 // Ensure that terminators only exist at the end of the basic block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002181 Assert(&I == I.getParent()->getTerminator(),
2182 "Terminator found in the middle of a basic block!", I.getParent());
Chris Lattner7af3ee92002-07-18 00:13:42 +00002183 visitInstruction(I);
Chris Lattner069a7952002-06-25 15:56:27 +00002184}
2185
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002186void Verifier::visitBranchInst(BranchInst &BI) {
2187 if (BI.isConditional()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002188 Assert(BI.getCondition()->getType()->isIntegerTy(1),
2189 "Branch condition is not 'i1' type!", &BI, BI.getCondition());
Nick Lewycky1d9a8152010-02-15 22:09:09 +00002190 }
2191 visitTerminatorInst(BI);
2192}
2193
Chris Lattner069a7952002-06-25 15:56:27 +00002194void Verifier::visitReturnInst(ReturnInst &RI) {
2195 Function *F = RI.getParent()->getParent();
Devang Patel59643e52008-02-23 00:35:18 +00002196 unsigned N = RI.getNumOperands();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002197 if (F->getReturnType()->isVoidTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002198 Assert(N == 0,
2199 "Found return instr that returns non-void in Function of void "
2200 "return type!",
2201 &RI, F->getReturnType());
Jay Foad11522092011-04-04 07:44:02 +00002202 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002203 Assert(N == 1 && F->getReturnType() == RI.getOperand(0)->getType(),
2204 "Function return type does not match operand "
2205 "type of return inst!",
2206 &RI, F->getReturnType());
Nick Lewycky3fc89802009-09-07 20:44:51 +00002207
Misha Brukman7eb05a12003-08-18 14:43:39 +00002208 // Check to make sure that the return value has necessary properties for
Chris Lattner069a7952002-06-25 15:56:27 +00002209 // terminators...
2210 visitTerminatorInst(RI);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00002211}
2212
Chris Lattnerab5aa142004-05-21 16:47:21 +00002213void Verifier::visitSwitchInst(SwitchInst &SI) {
2214 // Check to make sure that all of the constants in the switch instruction
2215 // have the same type as the switched-on value.
Chris Lattner229907c2011-07-18 04:54:35 +00002216 Type *SwitchTy = SI.getCondition()->getType();
Bob Wilsone4077362013-09-09 19:14:35 +00002217 SmallPtrSet<ConstantInt*, 32> Constants;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002218 for (auto &Case : SI.cases()) {
2219 Assert(Case.getCaseValue()->getType() == SwitchTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002220 "Switch constants must all be same type as switch value!", &SI);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002221 Assert(Constants.insert(Case.getCaseValue()).second,
2222 "Duplicate integer as switch case", &SI, Case.getCaseValue());
Stepan Dyatkovskiye89dafd2012-05-21 10:44:40 +00002223 }
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002224
Chris Lattnerab5aa142004-05-21 16:47:21 +00002225 visitTerminatorInst(SI);
2226}
2227
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002228void Verifier::visitIndirectBrInst(IndirectBrInst &BI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002229 Assert(BI.getAddress()->getType()->isPointerTy(),
2230 "Indirectbr operand must have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002231 for (unsigned i = 0, e = BI.getNumDestinations(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002232 Assert(BI.getDestination(i)->getType()->isLabelTy(),
2233 "Indirectbr destinations must all have pointer type!", &BI);
Dan Gohmand0a1e3d2010-08-02 23:08:33 +00002234
2235 visitTerminatorInst(BI);
2236}
2237
Chris Lattner75648e72004-03-12 05:54:31 +00002238void Verifier::visitSelectInst(SelectInst &SI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002239 Assert(!SelectInst::areInvalidOperands(SI.getOperand(0), SI.getOperand(1),
2240 SI.getOperand(2)),
2241 "Invalid operands for select instruction!", &SI);
Chris Lattner88107952008-12-29 00:12:50 +00002242
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002243 Assert(SI.getTrueValue()->getType() == SI.getType(),
2244 "Select values must have same type as select instruction!", &SI);
Chris Lattnercde15fb2004-09-29 21:19:28 +00002245 visitInstruction(SI);
Chris Lattner75648e72004-03-12 05:54:31 +00002246}
2247
Misha Brukmanc566ca362004-03-02 00:22:19 +00002248/// visitUserOp1 - User defined operators shouldn't live beyond the lifetime of
2249/// a pass, if any exist, it's an error.
2250///
Chris Lattner903a25d2002-11-21 16:54:22 +00002251void Verifier::visitUserOp1(Instruction &I) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00002252 Assert(false, "User-defined operators should not live outside of a pass!", &I);
Chris Lattner903a25d2002-11-21 16:54:22 +00002253}
Chris Lattner0e851da2002-04-18 20:37:37 +00002254
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002255void Verifier::visitTruncInst(TruncInst &I) {
2256 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002257 Type *SrcTy = I.getOperand(0)->getType();
2258 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002259
2260 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002261 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2262 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002263
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002264 Assert(SrcTy->isIntOrIntVectorTy(), "Trunc only operates on integer", &I);
2265 Assert(DestTy->isIntOrIntVectorTy(), "Trunc only produces integer", &I);
2266 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2267 "trunc source and destination must both be a vector or neither", &I);
2268 Assert(SrcBitSize > DestBitSize, "DestTy too big for Trunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002269
2270 visitInstruction(I);
2271}
2272
2273void Verifier::visitZExtInst(ZExtInst &I) {
2274 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002275 Type *SrcTy = I.getOperand(0)->getType();
2276 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002277
2278 // Get the size of the types in bits, we'll need this later
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002279 Assert(SrcTy->isIntOrIntVectorTy(), "ZExt only operates on integer", &I);
2280 Assert(DestTy->isIntOrIntVectorTy(), "ZExt only produces an integer", &I);
2281 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2282 "zext source and destination must both be a vector or neither", &I);
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002283 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2284 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002285
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002286 Assert(SrcBitSize < DestBitSize, "Type too small for ZExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002287
2288 visitInstruction(I);
2289}
2290
2291void Verifier::visitSExtInst(SExtInst &I) {
2292 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002293 Type *SrcTy = I.getOperand(0)->getType();
2294 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002295
2296 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002297 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2298 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002299
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002300 Assert(SrcTy->isIntOrIntVectorTy(), "SExt only operates on integer", &I);
2301 Assert(DestTy->isIntOrIntVectorTy(), "SExt only produces an integer", &I);
2302 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2303 "sext source and destination must both be a vector or neither", &I);
2304 Assert(SrcBitSize < DestBitSize, "Type too small for SExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002305
2306 visitInstruction(I);
2307}
2308
2309void Verifier::visitFPTruncInst(FPTruncInst &I) {
2310 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002311 Type *SrcTy = I.getOperand(0)->getType();
2312 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002313 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002314 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2315 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002316
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002317 Assert(SrcTy->isFPOrFPVectorTy(), "FPTrunc only operates on FP", &I);
2318 Assert(DestTy->isFPOrFPVectorTy(), "FPTrunc only produces an FP", &I);
2319 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2320 "fptrunc source and destination must both be a vector or neither", &I);
2321 Assert(SrcBitSize > DestBitSize, "DestTy too big for FPTrunc", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002322
2323 visitInstruction(I);
2324}
2325
2326void Verifier::visitFPExtInst(FPExtInst &I) {
2327 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002328 Type *SrcTy = I.getOperand(0)->getType();
2329 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002330
2331 // Get the size of the types in bits, we'll need this later
Dan Gohman7ccc52f2009-06-15 22:12:54 +00002332 unsigned SrcBitSize = SrcTy->getScalarSizeInBits();
2333 unsigned DestBitSize = DestTy->getScalarSizeInBits();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002334
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002335 Assert(SrcTy->isFPOrFPVectorTy(), "FPExt only operates on FP", &I);
2336 Assert(DestTy->isFPOrFPVectorTy(), "FPExt only produces an FP", &I);
2337 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(),
2338 "fpext source and destination must both be a vector or neither", &I);
2339 Assert(SrcBitSize < DestBitSize, "DestTy too small for FPExt", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002340
2341 visitInstruction(I);
2342}
2343
2344void Verifier::visitUIToFPInst(UIToFPInst &I) {
2345 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002346 Type *SrcTy = I.getOperand(0)->getType();
2347 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002348
Duncan Sands19d0b472010-02-16 11:11:14 +00002349 bool SrcVec = SrcTy->isVectorTy();
2350 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002351
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002352 Assert(SrcVec == DstVec,
2353 "UIToFP source and dest must both be vector or scalar", &I);
2354 Assert(SrcTy->isIntOrIntVectorTy(),
2355 "UIToFP source must be integer or integer vector", &I);
2356 Assert(DestTy->isFPOrFPVectorTy(), "UIToFP result must be FP or FP vector",
2357 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002358
2359 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002360 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2361 cast<VectorType>(DestTy)->getNumElements(),
2362 "UIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002363
2364 visitInstruction(I);
2365}
2366
2367void Verifier::visitSIToFPInst(SIToFPInst &I) {
2368 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002369 Type *SrcTy = I.getOperand(0)->getType();
2370 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002371
Duncan Sands19d0b472010-02-16 11:11:14 +00002372 bool SrcVec = SrcTy->isVectorTy();
2373 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002374
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002375 Assert(SrcVec == DstVec,
2376 "SIToFP source and dest must both be vector or scalar", &I);
2377 Assert(SrcTy->isIntOrIntVectorTy(),
2378 "SIToFP source must be integer or integer vector", &I);
2379 Assert(DestTy->isFPOrFPVectorTy(), "SIToFP result must be FP or FP vector",
2380 &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002381
2382 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002383 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2384 cast<VectorType>(DestTy)->getNumElements(),
2385 "SIToFP source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002386
2387 visitInstruction(I);
2388}
2389
2390void Verifier::visitFPToUIInst(FPToUIInst &I) {
2391 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002392 Type *SrcTy = I.getOperand(0)->getType();
2393 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002394
Duncan Sands19d0b472010-02-16 11:11:14 +00002395 bool SrcVec = SrcTy->isVectorTy();
2396 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002397
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002398 Assert(SrcVec == DstVec,
2399 "FPToUI source and dest must both be vector or scalar", &I);
2400 Assert(SrcTy->isFPOrFPVectorTy(), "FPToUI source must be FP or FP vector",
2401 &I);
2402 Assert(DestTy->isIntOrIntVectorTy(),
2403 "FPToUI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002404
2405 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002406 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2407 cast<VectorType>(DestTy)->getNumElements(),
2408 "FPToUI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002409
2410 visitInstruction(I);
2411}
2412
2413void Verifier::visitFPToSIInst(FPToSIInst &I) {
2414 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002415 Type *SrcTy = I.getOperand(0)->getType();
2416 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002417
Duncan Sands19d0b472010-02-16 11:11:14 +00002418 bool SrcVec = SrcTy->isVectorTy();
2419 bool DstVec = DestTy->isVectorTy();
Nate Begemand4d45c22007-11-17 03:58:34 +00002420
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002421 Assert(SrcVec == DstVec,
2422 "FPToSI source and dest must both be vector or scalar", &I);
2423 Assert(SrcTy->isFPOrFPVectorTy(), "FPToSI source must be FP or FP vector",
2424 &I);
2425 Assert(DestTy->isIntOrIntVectorTy(),
2426 "FPToSI result must be integer or integer vector", &I);
Nate Begemand4d45c22007-11-17 03:58:34 +00002427
2428 if (SrcVec && DstVec)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002429 Assert(cast<VectorType>(SrcTy)->getNumElements() ==
2430 cast<VectorType>(DestTy)->getNumElements(),
2431 "FPToSI source and dest vector length mismatch", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002432
2433 visitInstruction(I);
2434}
2435
2436void Verifier::visitPtrToIntInst(PtrToIntInst &I) {
2437 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002438 Type *SrcTy = I.getOperand(0)->getType();
2439 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002440
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002441 Assert(SrcTy->getScalarType()->isPointerTy(),
2442 "PtrToInt source must be pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002443
2444 if (auto *PTy = dyn_cast<PointerType>(SrcTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002445 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002446 "ptrtoint not supported for non-integral pointers");
2447
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002448 Assert(DestTy->getScalarType()->isIntegerTy(),
2449 "PtrToInt result must be integral", &I);
2450 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "PtrToInt type mismatch",
2451 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002452
2453 if (SrcTy->isVectorTy()) {
2454 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2455 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002456 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2457 "PtrToInt Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002458 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002459
2460 visitInstruction(I);
2461}
2462
2463void Verifier::visitIntToPtrInst(IntToPtrInst &I) {
2464 // Get the source and destination types
Chris Lattner229907c2011-07-18 04:54:35 +00002465 Type *SrcTy = I.getOperand(0)->getType();
2466 Type *DestTy = I.getType();
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002467
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002468 Assert(SrcTy->getScalarType()->isIntegerTy(),
2469 "IntToPtr source must be an integral", &I);
2470 Assert(DestTy->getScalarType()->isPointerTy(),
2471 "IntToPtr result must be a pointer", &I);
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002472
2473 if (auto *PTy = dyn_cast<PointerType>(DestTy->getScalarType()))
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00002474 Assert(!DL.isNonIntegralPointerType(PTy),
Sanjoy Dasc6af5ea2016-07-28 23:43:38 +00002475 "inttoptr not supported for non-integral pointers");
2476
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002477 Assert(SrcTy->isVectorTy() == DestTy->isVectorTy(), "IntToPtr type mismatch",
2478 &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002479 if (SrcTy->isVectorTy()) {
2480 VectorType *VSrc = dyn_cast<VectorType>(SrcTy);
2481 VectorType *VDest = dyn_cast<VectorType>(DestTy);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002482 Assert(VSrc->getNumElements() == VDest->getNumElements(),
2483 "IntToPtr Vector width mismatch", &I);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002484 }
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002485 visitInstruction(I);
2486}
2487
2488void Verifier::visitBitCastInst(BitCastInst &I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002489 Assert(
Rafael Espindolaa4a94f12014-12-16 19:29:29 +00002490 CastInst::castIsValid(Instruction::BitCast, I.getOperand(0), I.getType()),
2491 "Invalid bitcast", &I);
Reid Spencer6c38f0b2006-11-27 01:05:10 +00002492 visitInstruction(I);
2493}
2494
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002495void Verifier::visitAddrSpaceCastInst(AddrSpaceCastInst &I) {
2496 Type *SrcTy = I.getOperand(0)->getType();
2497 Type *DestTy = I.getType();
2498
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002499 Assert(SrcTy->isPtrOrPtrVectorTy(), "AddrSpaceCast source must be a pointer",
2500 &I);
2501 Assert(DestTy->isPtrOrPtrVectorTy(), "AddrSpaceCast result must be a pointer",
2502 &I);
2503 Assert(SrcTy->getPointerAddressSpace() != DestTy->getPointerAddressSpace(),
2504 "AddrSpaceCast must be between different address spaces", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002505 if (SrcTy->isVectorTy())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002506 Assert(SrcTy->getVectorNumElements() == DestTy->getVectorNumElements(),
2507 "AddrSpaceCast vector pointer number of elements mismatch", &I);
Matt Arsenaultb03bd4d2013-11-15 01:34:59 +00002508 visitInstruction(I);
2509}
2510
Misha Brukmanc566ca362004-03-02 00:22:19 +00002511/// visitPHINode - Ensure that a PHI node is well formed.
2512///
Chris Lattner069a7952002-06-25 15:56:27 +00002513void Verifier::visitPHINode(PHINode &PN) {
2514 // Ensure that the PHI nodes are all grouped together at the top of the block.
2515 // This can be tested by checking whether the instruction before this is
Misha Brukmanfa100532003-10-10 17:54:14 +00002516 // either nonexistent (because this is begin()) or is a PHI node. If not,
Chris Lattner069a7952002-06-25 15:56:27 +00002517 // then there is some other instruction before a PHI.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002518 Assert(&PN == &PN.getParent()->front() ||
2519 isa<PHINode>(--BasicBlock::iterator(&PN)),
2520 "PHI nodes not grouped at top of basic block!", &PN, PN.getParent());
Chris Lattner069a7952002-06-25 15:56:27 +00002521
David Majnemerb611e3f2015-08-14 05:09:07 +00002522 // Check that a PHI doesn't yield a Token.
2523 Assert(!PN.getType()->isTokenTy(), "PHI nodes cannot have token type!");
2524
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002525 // Check that all of the values of the PHI node have the same type as the
2526 // result, and that the incoming blocks are really basic blocks.
Pete Cooper833f34d2015-05-12 20:05:31 +00002527 for (Value *IncValue : PN.incoming_values()) {
2528 Assert(PN.getType() == IncValue->getType(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002529 "PHI node operands are not the same type as the result!", &PN);
Nick Lewyckyb2b04672009-09-08 01:23:52 +00002530 }
Chris Lattner3b93c912003-11-12 07:13:37 +00002531
Chris Lattnerdf9779c2003-10-05 17:44:18 +00002532 // All other PHI node constraints are checked in the visitBasicBlock method.
Chris Lattner0e851da2002-04-18 20:37:37 +00002533
2534 visitInstruction(PN);
2535}
2536
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002537void Verifier::verifyCallSite(CallSite CS) {
Duncan Sands8c582282007-12-21 19:19:01 +00002538 Instruction *I = CS.getInstruction();
2539
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002540 Assert(CS.getCalledValue()->getType()->isPointerTy(),
2541 "Called function must be a pointer!", I);
Chris Lattner229907c2011-07-18 04:54:35 +00002542 PointerType *FPTy = cast<PointerType>(CS.getCalledValue()->getType());
Chris Lattner338a4622002-05-08 19:49:50 +00002543
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002544 Assert(FPTy->getElementType()->isFunctionTy(),
2545 "Called function is not pointer to function type!", I);
David Blaikie348de692015-04-23 21:36:23 +00002546
2547 Assert(FPTy->getElementType() == CS.getFunctionType(),
2548 "Called function is not the same type as the call!", I);
2549
2550 FunctionType *FTy = CS.getFunctionType();
Chris Lattner338a4622002-05-08 19:49:50 +00002551
2552 // Verify that the correct number of arguments are being passed
2553 if (FTy->isVarArg())
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002554 Assert(CS.arg_size() >= FTy->getNumParams(),
2555 "Called function requires more parameters than were provided!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002556 else
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002557 Assert(CS.arg_size() == FTy->getNumParams(),
2558 "Incorrect number of arguments passed to called function!", I);
Chris Lattner338a4622002-05-08 19:49:50 +00002559
Chris Lattner609de002010-05-10 20:58:42 +00002560 // Verify that all arguments to the call match the function type.
Chris Lattner338a4622002-05-08 19:49:50 +00002561 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002562 Assert(CS.getArgument(i)->getType() == FTy->getParamType(i),
2563 "Call parameter type does not match function signature!",
2564 CS.getArgument(i), FTy->getParamType(i), I);
Duncan Sands8c582282007-12-21 19:19:01 +00002565
Bill Wendlinge3a60a92013-04-18 20:15:25 +00002566 AttributeSet Attrs = CS.getAttributes();
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002567
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002568 Assert(verifyAttributeCount(Attrs, CS.arg_size()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002569 "Attribute after last parameter!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002570
Duncan Sands8c582282007-12-21 19:19:01 +00002571 // Verify call attributes.
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002572 verifyFunctionAttrs(FTy, Attrs, I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002573
David Majnemer91db08b2014-04-30 17:22:00 +00002574 // Conservatively check the inalloca argument.
2575 // We have a bug if we can find that there is an underlying alloca without
2576 // inalloca.
2577 if (CS.hasInAllocaArgument()) {
2578 Value *InAllocaArg = CS.getArgument(FTy->getNumParams() - 1);
2579 if (auto AI = dyn_cast<AllocaInst>(InAllocaArg->stripInBoundsOffsets()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002580 Assert(AI->isUsedWithInAlloca(),
2581 "inalloca argument for call has mismatched alloca", AI, I);
David Majnemer91db08b2014-04-30 17:22:00 +00002582 }
2583
Manman Ren9bfd0d02016-04-01 21:41:15 +00002584 // For each argument of the callsite, if it has the swifterror argument,
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002585 // make sure the underlying alloca/parameter it comes from has a swifterror as
2586 // well.
Manman Ren9bfd0d02016-04-01 21:41:15 +00002587 for (unsigned i = 0, e = FTy->getNumParams(); i != e; ++i)
2588 if (CS.paramHasAttr(i+1, Attribute::SwiftError)) {
2589 Value *SwiftErrorArg = CS.getArgument(i);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002590 if (auto AI = dyn_cast<AllocaInst>(SwiftErrorArg->stripInBoundsOffsets())) {
Manman Ren9bfd0d02016-04-01 21:41:15 +00002591 Assert(AI->isSwiftError(),
2592 "swifterror argument for call has mismatched alloca", AI, I);
Arnold Schwaighofer6c57f4f2016-09-10 19:42:53 +00002593 continue;
2594 }
2595 auto ArgI = dyn_cast<Argument>(SwiftErrorArg);
2596 Assert(ArgI, "swifterror argument should come from an alloca or parameter", SwiftErrorArg, I);
2597 Assert(ArgI->hasSwiftErrorAttr(),
2598 "swifterror argument for call has mismatched parameter", ArgI, I);
Manman Ren9bfd0d02016-04-01 21:41:15 +00002599 }
2600
Stephen Linb8bd2322013-04-20 05:14:40 +00002601 if (FTy->isVarArg()) {
2602 // FIXME? is 'nest' even legal here?
2603 bool SawNest = false;
2604 bool SawReturned = false;
2605
2606 for (unsigned Idx = 1; Idx < 1 + FTy->getNumParams(); ++Idx) {
2607 if (Attrs.hasAttribute(Idx, Attribute::Nest))
2608 SawNest = true;
2609 if (Attrs.hasAttribute(Idx, Attribute::Returned))
2610 SawReturned = true;
2611 }
2612
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002613 // Check attributes on the varargs part.
2614 for (unsigned Idx = 1 + FTy->getNumParams(); Idx <= CS.arg_size(); ++Idx) {
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002615 Type *Ty = CS.getArgument(Idx-1)->getType();
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002616 verifyParameterAttrs(Attrs, Idx, Ty, false, I);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00002617
Stephen Linb8bd2322013-04-20 05:14:40 +00002618 if (Attrs.hasAttribute(Idx, Attribute::Nest)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002619 Assert(!SawNest, "More than one parameter has attribute nest!", I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002620 SawNest = true;
2621 }
2622
2623 if (Attrs.hasAttribute(Idx, Attribute::Returned)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002624 Assert(!SawReturned, "More than one parameter has attribute returned!",
2625 I);
2626 Assert(Ty->canLosslesslyBitCastTo(FTy->getReturnType()),
2627 "Incompatible argument and return types for 'returned' "
2628 "attribute",
2629 I);
Stephen Linb8bd2322013-04-20 05:14:40 +00002630 SawReturned = true;
2631 }
Duncan Sands0009c442008-01-12 16:42:01 +00002632
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002633 Assert(!Attrs.hasAttribute(Idx, Attribute::StructRet),
2634 "Attribute 'sret' cannot be used for vararg call arguments!", I);
Reid Kleckner60d3a832014-01-16 22:59:24 +00002635
2636 if (Attrs.hasAttribute(Idx, Attribute::InAlloca))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002637 Assert(Idx == CS.arg_size(), "inalloca isn't on the last argument!", I);
Duncan Sandsb99f44a2008-01-11 22:36:48 +00002638 }
Stephen Linb8bd2322013-04-20 05:14:40 +00002639 }
Duncan Sands8c582282007-12-21 19:19:01 +00002640
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002641 // Verify that there's no metadata unless it's a direct call to an intrinsic.
Craig Topperc6207612014-04-09 06:08:46 +00002642 if (CS.getCalledFunction() == nullptr ||
Chris Lattner609de002010-05-10 20:58:42 +00002643 !CS.getCalledFunction()->getName().startswith("llvm.")) {
David Majnemerb611e3f2015-08-14 05:09:07 +00002644 for (Type *ParamTy : FTy->params()) {
2645 Assert(!ParamTy->isMetadataTy(),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002646 "Function has metadata parameter but isn't an intrinsic", I);
David Majnemerb611e3f2015-08-14 05:09:07 +00002647 Assert(!ParamTy->isTokenTy(),
2648 "Function has token parameter but isn't an intrinsic", I);
2649 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002650 }
2651
David Majnemerb611e3f2015-08-14 05:09:07 +00002652 // Verify that indirect calls don't return tokens.
2653 if (CS.getCalledFunction() == nullptr)
2654 Assert(!FTy->getReturnType()->isTokenTy(),
2655 "Return type cannot be token for indirect call!");
2656
Philip Reamesa3c6f002015-06-26 21:39:44 +00002657 if (Function *F = CS.getCalledFunction())
2658 if (Intrinsic::ID ID = (Intrinsic::ID)F->getIntrinsicID())
Philip Reames007561a2015-06-26 22:21:52 +00002659 visitIntrinsicCallSite(ID, CS);
Philip Reamesa3c6f002015-06-26 21:39:44 +00002660
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002661 // Verify that a callsite has at most one "deopt", at most one "funclet" and
2662 // at most one "gc-transition" operand bundle.
2663 bool FoundDeoptBundle = false, FoundFuncletBundle = false,
2664 FoundGCTransitionBundle = false;
Sanjoy Dascdafd842015-11-11 21:38:02 +00002665 for (unsigned i = 0, e = CS.getNumOperandBundles(); i < e; ++i) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002666 OperandBundleUse BU = CS.getOperandBundleAt(i);
2667 uint32_t Tag = BU.getTagID();
2668 if (Tag == LLVMContext::OB_deopt) {
Sanjoy Dascdafd842015-11-11 21:38:02 +00002669 Assert(!FoundDeoptBundle, "Multiple deopt operand bundles", I);
2670 FoundDeoptBundle = true;
Sanjoy Dasa34ce952016-01-20 19:50:25 +00002671 } else if (Tag == LLVMContext::OB_gc_transition) {
2672 Assert(!FoundGCTransitionBundle, "Multiple gc-transition operand bundles",
2673 I);
2674 FoundGCTransitionBundle = true;
2675 } else if (Tag == LLVMContext::OB_funclet) {
David Majnemer3bb88c02015-12-15 21:27:27 +00002676 Assert(!FoundFuncletBundle, "Multiple funclet operand bundles", I);
2677 FoundFuncletBundle = true;
2678 Assert(BU.Inputs.size() == 1,
2679 "Expected exactly one funclet bundle operand", I);
2680 Assert(isa<FuncletPadInst>(BU.Inputs.front()),
2681 "Funclet bundle operands should correspond to a FuncletPadInst",
2682 I);
2683 }
Sanjoy Dascdafd842015-11-11 21:38:02 +00002684 }
2685
Adrian Prantl93035c82016-04-24 22:23:13 +00002686 // Verify that each inlinable callsite of a debug-info-bearing function in a
2687 // debug-info-bearing function has a debug location attached to it. Failure to
2688 // do so causes assertion failures when the inliner sets up inline scope info.
2689 if (I->getFunction()->getSubprogram() && CS.getCalledFunction() &&
2690 CS.getCalledFunction()->getSubprogram())
2691 Assert(I->getDebugLoc(), "inlinable function call in a function with debug "
2692 "info must have a !dbg location",
2693 I);
2694
Duncan Sands8c582282007-12-21 19:19:01 +00002695 visitInstruction(*I);
2696}
2697
Reid Kleckner5772b772014-04-24 20:14:34 +00002698/// Two types are "congruent" if they are identical, or if they are both pointer
2699/// types with different pointee types and the same address space.
2700static bool isTypeCongruent(Type *L, Type *R) {
2701 if (L == R)
2702 return true;
2703 PointerType *PL = dyn_cast<PointerType>(L);
2704 PointerType *PR = dyn_cast<PointerType>(R);
2705 if (!PL || !PR)
2706 return false;
2707 return PL->getAddressSpace() == PR->getAddressSpace();
2708}
2709
Reid Klecknerd20c9702014-05-15 23:58:57 +00002710static AttrBuilder getParameterABIAttributes(int I, AttributeSet Attrs) {
2711 static const Attribute::AttrKind ABIAttrs[] = {
2712 Attribute::StructRet, Attribute::ByVal, Attribute::InAlloca,
Manman Ren9bfd0d02016-04-01 21:41:15 +00002713 Attribute::InReg, Attribute::Returned, Attribute::SwiftSelf,
2714 Attribute::SwiftError};
Reid Klecknerd20c9702014-05-15 23:58:57 +00002715 AttrBuilder Copy;
2716 for (auto AK : ABIAttrs) {
2717 if (Attrs.hasAttribute(I + 1, AK))
2718 Copy.addAttribute(AK);
2719 }
2720 if (Attrs.hasAttribute(I + 1, Attribute::Alignment))
2721 Copy.addAlignmentAttr(Attrs.getParamAlignment(I + 1));
2722 return Copy;
2723}
2724
Reid Kleckner5772b772014-04-24 20:14:34 +00002725void Verifier::verifyMustTailCall(CallInst &CI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002726 Assert(!CI.isInlineAsm(), "cannot use musttail call with inline asm", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002727
2728 // - The caller and callee prototypes must match. Pointer types of
2729 // parameters or return types may differ in pointee type, but not
2730 // address space.
2731 Function *F = CI.getParent()->getParent();
David Blaikie5bacf372015-04-24 21:16:07 +00002732 FunctionType *CallerTy = F->getFunctionType();
2733 FunctionType *CalleeTy = CI.getFunctionType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002734 Assert(CallerTy->getNumParams() == CalleeTy->getNumParams(),
2735 "cannot guarantee tail call due to mismatched parameter counts", &CI);
2736 Assert(CallerTy->isVarArg() == CalleeTy->isVarArg(),
2737 "cannot guarantee tail call due to mismatched varargs", &CI);
2738 Assert(isTypeCongruent(CallerTy->getReturnType(), CalleeTy->getReturnType()),
2739 "cannot guarantee tail call due to mismatched return types", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002740 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002741 Assert(
Reid Kleckner5772b772014-04-24 20:14:34 +00002742 isTypeCongruent(CallerTy->getParamType(I), CalleeTy->getParamType(I)),
2743 "cannot guarantee tail call due to mismatched parameter types", &CI);
2744 }
2745
2746 // - The calling conventions of the caller and callee must match.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002747 Assert(F->getCallingConv() == CI.getCallingConv(),
2748 "cannot guarantee tail call due to mismatched calling conv", &CI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002749
2750 // - All ABI-impacting function attributes, such as sret, byval, inreg,
2751 // returned, and inalloca, must match.
Reid Kleckner5772b772014-04-24 20:14:34 +00002752 AttributeSet CallerAttrs = F->getAttributes();
2753 AttributeSet CalleeAttrs = CI.getAttributes();
2754 for (int I = 0, E = CallerTy->getNumParams(); I != E; ++I) {
Reid Klecknerd20c9702014-05-15 23:58:57 +00002755 AttrBuilder CallerABIAttrs = getParameterABIAttributes(I, CallerAttrs);
2756 AttrBuilder CalleeABIAttrs = getParameterABIAttributes(I, CalleeAttrs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002757 Assert(CallerABIAttrs == CalleeABIAttrs,
2758 "cannot guarantee tail call due to mismatched ABI impacting "
2759 "function attributes",
2760 &CI, CI.getOperand(I));
Reid Kleckner5772b772014-04-24 20:14:34 +00002761 }
2762
2763 // - The call must immediately precede a :ref:`ret <i_ret>` instruction,
2764 // or a pointer bitcast followed by a ret instruction.
2765 // - The ret instruction must return the (possibly bitcasted) value
2766 // produced by the call or void.
2767 Value *RetVal = &CI;
2768 Instruction *Next = CI.getNextNode();
2769
2770 // Handle the optional bitcast.
2771 if (BitCastInst *BI = dyn_cast_or_null<BitCastInst>(Next)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002772 Assert(BI->getOperand(0) == RetVal,
2773 "bitcast following musttail call must use the call", BI);
Reid Kleckner5772b772014-04-24 20:14:34 +00002774 RetVal = BI;
2775 Next = BI->getNextNode();
2776 }
2777
2778 // Check the return.
2779 ReturnInst *Ret = dyn_cast_or_null<ReturnInst>(Next);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002780 Assert(Ret, "musttail call must be precede a ret with an optional bitcast",
2781 &CI);
2782 Assert(!Ret->getReturnValue() || Ret->getReturnValue() == RetVal,
2783 "musttail call result must be returned", Ret);
Reid Kleckner5772b772014-04-24 20:14:34 +00002784}
2785
Duncan Sands8c582282007-12-21 19:19:01 +00002786void Verifier::visitCallInst(CallInst &CI) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002787 verifyCallSite(&CI);
Chris Lattner7af3ee92002-07-18 00:13:42 +00002788
Reid Kleckner5772b772014-04-24 20:14:34 +00002789 if (CI.isMustTailCall())
2790 verifyMustTailCall(CI);
Duncan Sands8c582282007-12-21 19:19:01 +00002791}
2792
2793void Verifier::visitInvokeInst(InvokeInst &II) {
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00002794 verifyCallSite(&II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002795
David Majnemer654e1302015-07-31 17:58:14 +00002796 // Verify that the first non-PHI instruction of the unwind destination is an
2797 // exception handling instruction.
2798 Assert(
2799 II.getUnwindDest()->isEHPad(),
2800 "The unwind destination does not have an exception handling instruction!",
2801 &II);
Bill Wendlingf4bbc042011-09-21 22:57:02 +00002802
Dan Gohman9c6e1882010-08-02 23:09:14 +00002803 visitTerminatorInst(II);
Chris Lattner21ea83b2002-04-18 22:11:52 +00002804}
Chris Lattner0e851da2002-04-18 20:37:37 +00002805
Misha Brukmanc566ca362004-03-02 00:22:19 +00002806/// visitBinaryOperator - Check that both arguments to the binary operator are
2807/// of the same type!
2808///
Chris Lattner069a7952002-06-25 15:56:27 +00002809void Verifier::visitBinaryOperator(BinaryOperator &B) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002810 Assert(B.getOperand(0)->getType() == B.getOperand(1)->getType(),
2811 "Both operands to a binary operator are not of the same type!", &B);
Chris Lattner0e851da2002-04-18 20:37:37 +00002812
Reid Spencer2341c222007-02-02 02:16:23 +00002813 switch (B.getOpcode()) {
Dan Gohman5208dd82009-06-05 16:10:00 +00002814 // Check that integer arithmetic operators are only used with
2815 // integral operands.
2816 case Instruction::Add:
2817 case Instruction::Sub:
2818 case Instruction::Mul:
2819 case Instruction::SDiv:
2820 case Instruction::UDiv:
2821 case Instruction::SRem:
2822 case Instruction::URem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002823 Assert(B.getType()->isIntOrIntVectorTy(),
2824 "Integer arithmetic operators only work with integral types!", &B);
2825 Assert(B.getType() == B.getOperand(0)->getType(),
2826 "Integer arithmetic operators must have same type "
2827 "for operands and result!",
2828 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002829 break;
2830 // Check that floating-point arithmetic operators are only used with
2831 // floating-point operands.
2832 case Instruction::FAdd:
2833 case Instruction::FSub:
2834 case Instruction::FMul:
2835 case Instruction::FDiv:
2836 case Instruction::FRem:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002837 Assert(B.getType()->isFPOrFPVectorTy(),
2838 "Floating-point arithmetic operators only work with "
2839 "floating-point types!",
2840 &B);
2841 Assert(B.getType() == B.getOperand(0)->getType(),
2842 "Floating-point arithmetic operators must have same type "
2843 "for operands and result!",
2844 &B);
Dan Gohman5208dd82009-06-05 16:10:00 +00002845 break;
Chris Lattner1f419252002-09-09 20:26:04 +00002846 // Check that logical operators are only used with integral operands.
Reid Spencer2341c222007-02-02 02:16:23 +00002847 case Instruction::And:
2848 case Instruction::Or:
2849 case Instruction::Xor:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002850 Assert(B.getType()->isIntOrIntVectorTy(),
2851 "Logical operators only work with integral types!", &B);
2852 Assert(B.getType() == B.getOperand(0)->getType(),
2853 "Logical operators must have same type for operands and result!",
2854 &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002855 break;
2856 case Instruction::Shl:
2857 case Instruction::LShr:
2858 case Instruction::AShr:
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002859 Assert(B.getType()->isIntOrIntVectorTy(),
2860 "Shifts only work with integral types!", &B);
2861 Assert(B.getType() == B.getOperand(0)->getType(),
2862 "Shift return type must be same as operands!", &B);
Reid Spencer2341c222007-02-02 02:16:23 +00002863 break;
Dan Gohman5208dd82009-06-05 16:10:00 +00002864 default:
Torok Edwinfbcc6632009-07-14 16:55:14 +00002865 llvm_unreachable("Unknown BinaryOperator opcode!");
Chris Lattner1f419252002-09-09 20:26:04 +00002866 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00002867
Chris Lattner0e851da2002-04-18 20:37:37 +00002868 visitInstruction(B);
2869}
2870
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002871void Verifier::visitICmpInst(ICmpInst &IC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002872 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002873 Type *Op0Ty = IC.getOperand(0)->getType();
2874 Type *Op1Ty = IC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002875 Assert(Op0Ty == Op1Ty,
2876 "Both operands to ICmp instruction are not of the same type!", &IC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002877 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002878 Assert(Op0Ty->isIntOrIntVectorTy() || Op0Ty->getScalarType()->isPointerTy(),
2879 "Invalid operand types for ICmp instruction", &IC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002880 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002881 Assert(IC.getPredicate() >= CmpInst::FIRST_ICMP_PREDICATE &&
2882 IC.getPredicate() <= CmpInst::LAST_ICMP_PREDICATE,
2883 "Invalid predicate in ICmp instruction!", &IC);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00002884
Reid Spencerd9436b62006-11-20 01:22:35 +00002885 visitInstruction(IC);
2886}
2887
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002888void Verifier::visitFCmpInst(FCmpInst &FC) {
Reid Spencerd9436b62006-11-20 01:22:35 +00002889 // Check that the operands are the same type
Chris Lattner229907c2011-07-18 04:54:35 +00002890 Type *Op0Ty = FC.getOperand(0)->getType();
2891 Type *Op1Ty = FC.getOperand(1)->getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002892 Assert(Op0Ty == Op1Ty,
2893 "Both operands to FCmp instruction are not of the same type!", &FC);
Reid Spencerd9436b62006-11-20 01:22:35 +00002894 // Check that the operands are the right type
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002895 Assert(Op0Ty->isFPOrFPVectorTy(),
2896 "Invalid operand types for FCmp instruction", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002897 // Check that the predicate is valid.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002898 Assert(FC.getPredicate() >= CmpInst::FIRST_FCMP_PREDICATE &&
2899 FC.getPredicate() <= CmpInst::LAST_FCMP_PREDICATE,
2900 "Invalid predicate in FCmp instruction!", &FC);
Nick Lewyckyc72d2852010-08-22 23:45:14 +00002901
Reid Spencerd9436b62006-11-20 01:22:35 +00002902 visitInstruction(FC);
2903}
2904
Robert Bocchino23004482006-01-10 19:05:34 +00002905void Verifier::visitExtractElementInst(ExtractElementInst &EI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002906 Assert(
2907 ExtractElementInst::isValidOperands(EI.getOperand(0), EI.getOperand(1)),
2908 "Invalid extractelement operands!", &EI);
Robert Bocchino23004482006-01-10 19:05:34 +00002909 visitInstruction(EI);
2910}
2911
Robert Bocchinoca27f032006-01-17 20:07:22 +00002912void Verifier::visitInsertElementInst(InsertElementInst &IE) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002913 Assert(InsertElementInst::isValidOperands(IE.getOperand(0), IE.getOperand(1),
2914 IE.getOperand(2)),
2915 "Invalid insertelement operands!", &IE);
Robert Bocchinoca27f032006-01-17 20:07:22 +00002916 visitInstruction(IE);
2917}
2918
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002919void Verifier::visitShuffleVectorInst(ShuffleVectorInst &SV) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002920 Assert(ShuffleVectorInst::isValidOperands(SV.getOperand(0), SV.getOperand(1),
2921 SV.getOperand(2)),
2922 "Invalid shufflevector operands!", &SV);
Chris Lattnerbbe0a422006-04-08 01:18:18 +00002923 visitInstruction(SV);
2924}
2925
Chris Lattner069a7952002-06-25 15:56:27 +00002926void Verifier::visitGetElementPtrInst(GetElementPtrInst &GEP) {
Duncan Sandsa71ae962012-02-03 17:28:51 +00002927 Type *TargetTy = GEP.getPointerOperandType()->getScalarType();
Nadav Rotem3924cb02011-12-05 06:29:09 +00002928
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002929 Assert(isa<PointerType>(TargetTy),
2930 "GEP base pointer is not a vector or a vector of pointers", &GEP);
David Blaikiecc2cd582015-04-17 22:32:17 +00002931 Assert(GEP.getSourceElementType()->isSized(), "GEP into unsized type!", &GEP);
Chris Lattner84d82c72007-02-10 08:30:29 +00002932 SmallVector<Value*, 16> Idxs(GEP.idx_begin(), GEP.idx_end());
Chris Lattner229907c2011-07-18 04:54:35 +00002933 Type *ElTy =
David Blaikied288fb82015-03-30 21:41:43 +00002934 GetElementPtrInst::getIndexedType(GEP.getSourceElementType(), Idxs);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002935 Assert(ElTy, "Invalid indices for GEP pointer type!", &GEP);
Nadav Rotem3924cb02011-12-05 06:29:09 +00002936
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002937 Assert(GEP.getType()->getScalarType()->isPointerTy() &&
David Blaikied0a24822015-04-17 22:32:20 +00002938 GEP.getResultElementType() == ElTy,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002939 "GEP is not of right type for indices!", &GEP, ElTy);
Duncan Sandse6beec62012-11-13 12:59:33 +00002940
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002941 if (GEP.getType()->isVectorTy()) {
Duncan Sandse6beec62012-11-13 12:59:33 +00002942 // Additional checks for vector GEPs.
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002943 unsigned GEPWidth = GEP.getType()->getVectorNumElements();
2944 if (GEP.getPointerOperandType()->isVectorTy())
2945 Assert(GEPWidth == GEP.getPointerOperandType()->getVectorNumElements(),
2946 "Vector GEP result width doesn't match operand's", &GEP);
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00002947 for (Value *Idx : Idxs) {
2948 Type *IndexTy = Idx->getType();
Elena Demikhovsky37a4da82015-07-09 07:42:48 +00002949 if (IndexTy->isVectorTy()) {
2950 unsigned IndexWidth = IndexTy->getVectorNumElements();
2951 Assert(IndexWidth == GEPWidth, "Invalid GEP index vector width", &GEP);
2952 }
2953 Assert(IndexTy->getScalarType()->isIntegerTy(),
2954 "All GEP indices should be of integer type");
Duncan Sandse6beec62012-11-13 12:59:33 +00002955 }
Nadav Rotem3924cb02011-12-05 06:29:09 +00002956 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00002957 visitInstruction(GEP);
2958}
2959
Rafael Espindolae3c5f3e2012-05-31 16:04:26 +00002960static bool isContiguous(const ConstantRange &A, const ConstantRange &B) {
2961 return A.getUpper() == B.getLower() || A.getLower() == B.getUpper();
2962}
2963
Philip Reamesbf9676f2014-10-20 23:52:07 +00002964void Verifier::visitRangeMetadata(Instruction& I,
2965 MDNode* Range, Type* Ty) {
2966 assert(Range &&
2967 Range == I.getMetadata(LLVMContext::MD_range) &&
2968 "precondition violation");
2969
2970 unsigned NumOperands = Range->getNumOperands();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002971 Assert(NumOperands % 2 == 0, "Unfinished range!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002972 unsigned NumRanges = NumOperands / 2;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002973 Assert(NumRanges >= 1, "It should have at least one range!", Range);
2974
Philip Reamesbf9676f2014-10-20 23:52:07 +00002975 ConstantRange LastRange(1); // Dummy initial value
2976 for (unsigned i = 0; i < NumRanges; ++i) {
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002977 ConstantInt *Low =
2978 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002979 Assert(Low, "The lower limit must be an integer!", Low);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00002980 ConstantInt *High =
2981 mdconst::dyn_extract<ConstantInt>(Range->getOperand(2 * i + 1));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002982 Assert(High, "The upper limit must be an integer!", High);
2983 Assert(High->getType() == Low->getType() && High->getType() == Ty,
2984 "Range types must match instruction type!", &I);
2985
Philip Reamesbf9676f2014-10-20 23:52:07 +00002986 APInt HighV = High->getValue();
2987 APInt LowV = Low->getValue();
2988 ConstantRange CurRange(LowV, HighV);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002989 Assert(!CurRange.isEmptySet() && !CurRange.isFullSet(),
2990 "Range must not be empty!", Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002991 if (i != 0) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00002992 Assert(CurRange.intersectWith(LastRange).isEmptySet(),
2993 "Intervals are overlapping", Range);
2994 Assert(LowV.sgt(LastRange.getLower()), "Intervals are not in order",
2995 Range);
2996 Assert(!isContiguous(CurRange, LastRange), "Intervals are contiguous",
2997 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00002998 }
2999 LastRange = ConstantRange(LowV, HighV);
3000 }
3001 if (NumRanges > 2) {
3002 APInt FirstLow =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003003 mdconst::dyn_extract<ConstantInt>(Range->getOperand(0))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003004 APInt FirstHigh =
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003005 mdconst::dyn_extract<ConstantInt>(Range->getOperand(1))->getValue();
Philip Reamesbf9676f2014-10-20 23:52:07 +00003006 ConstantRange FirstRange(FirstLow, FirstHigh);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003007 Assert(FirstRange.intersectWith(LastRange).isEmptySet(),
3008 "Intervals are overlapping", Range);
3009 Assert(!isContiguous(FirstRange, LastRange), "Intervals are contiguous",
3010 Range);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003011 }
3012}
3013
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003014void Verifier::checkAtomicMemAccessSize(Type *Ty, const Instruction *I) {
3015 unsigned Size = DL.getTypeSizeInBits(Ty);
JF Bastiend1fb5852015-12-17 22:09:19 +00003016 Assert(Size >= 8, "atomic memory access' size must be byte-sized", Ty, I);
3017 Assert(!(Size & (Size - 1)),
3018 "atomic memory access' operand must have a power-of-two size", Ty, I);
3019}
3020
Chris Lattner069a7952002-06-25 15:56:27 +00003021void Verifier::visitLoadInst(LoadInst &LI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003022 PointerType *PTy = dyn_cast<PointerType>(LI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003023 Assert(PTy, "Load operand must be a pointer.", &LI);
David Blaikie15d9a4c2015-04-06 20:59:48 +00003024 Type *ElTy = LI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003025 Assert(LI.getAlignment() <= Value::MaximumAlignment,
3026 "huge alignment values are unsupported", &LI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003027 Assert(ElTy->isSized(), "loading unsized types is not allowed", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003028 if (LI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003029 Assert(LI.getOrdering() != AtomicOrdering::Release &&
3030 LI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003031 "Load cannot have Release ordering", &LI);
3032 Assert(LI.getAlignment() != 0,
3033 "Atomic load must specify explicit alignment", &LI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003034 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3035 ElTy->isFloatingPointTy(),
3036 "atomic load operand must have integer, pointer, or floating point "
3037 "type!",
3038 ElTy, &LI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003039 checkAtomicMemAccessSize(ElTy, &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003040 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003041 Assert(LI.getSynchScope() == CrossThread,
3042 "Non-atomic load cannot have SynchronizationScope specified", &LI);
Eli Friedman59b66882011-08-09 23:02:53 +00003043 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003044
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003045 visitInstruction(LI);
3046}
3047
Chris Lattner069a7952002-06-25 15:56:27 +00003048void Verifier::visitStoreInst(StoreInst &SI) {
Chris Lattner229907c2011-07-18 04:54:35 +00003049 PointerType *PTy = dyn_cast<PointerType>(SI.getOperand(1)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003050 Assert(PTy, "Store operand must be a pointer.", &SI);
Chris Lattner229907c2011-07-18 04:54:35 +00003051 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003052 Assert(ElTy == SI.getOperand(0)->getType(),
3053 "Stored value type does not match pointer operand type!", &SI, ElTy);
3054 Assert(SI.getAlignment() <= Value::MaximumAlignment,
3055 "huge alignment values are unsupported", &SI);
Sanjoy Dasc2cf6ef2016-06-01 16:13:10 +00003056 Assert(ElTy->isSized(), "storing unsized types is not allowed", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003057 if (SI.isAtomic()) {
JF Bastien800f87a2016-04-06 21:19:33 +00003058 Assert(SI.getOrdering() != AtomicOrdering::Acquire &&
3059 SI.getOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003060 "Store cannot have Acquire ordering", &SI);
3061 Assert(SI.getAlignment() != 0,
3062 "Atomic store must specify explicit alignment", &SI);
JF Bastiend1fb5852015-12-17 22:09:19 +00003063 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy() ||
3064 ElTy->isFloatingPointTy(),
3065 "atomic store operand must have integer, pointer, or floating point "
3066 "type!",
3067 ElTy, &SI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003068 checkAtomicMemAccessSize(ElTy, &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003069 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003070 Assert(SI.getSynchScope() == CrossThread,
3071 "Non-atomic store cannot have SynchronizationScope specified", &SI);
Eli Friedman59b66882011-08-09 23:02:53 +00003072 }
Chris Lattnerd46bb6e2002-04-24 19:12:21 +00003073 visitInstruction(SI);
3074}
3075
Manman Ren9bfd0d02016-04-01 21:41:15 +00003076/// Check that SwiftErrorVal is used as a swifterror argument in CS.
3077void Verifier::verifySwiftErrorCallSite(CallSite CS,
3078 const Value *SwiftErrorVal) {
3079 unsigned Idx = 0;
3080 for (CallSite::arg_iterator I = CS.arg_begin(), E = CS.arg_end();
3081 I != E; ++I, ++Idx) {
3082 if (*I == SwiftErrorVal) {
3083 Assert(CS.paramHasAttr(Idx+1, Attribute::SwiftError),
3084 "swifterror value when used in a callsite should be marked "
3085 "with swifterror attribute",
3086 SwiftErrorVal, CS);
3087 }
3088 }
3089}
3090
3091void Verifier::verifySwiftErrorValue(const Value *SwiftErrorVal) {
3092 // Check that swifterror value is only used by loads, stores, or as
3093 // a swifterror argument.
3094 for (const User *U : SwiftErrorVal->users()) {
3095 Assert(isa<LoadInst>(U) || isa<StoreInst>(U) || isa<CallInst>(U) ||
3096 isa<InvokeInst>(U),
3097 "swifterror value can only be loaded and stored from, or "
3098 "as a swifterror argument!",
3099 SwiftErrorVal, U);
3100 // If it is used by a store, check it is the second operand.
3101 if (auto StoreI = dyn_cast<StoreInst>(U))
3102 Assert(StoreI->getOperand(1) == SwiftErrorVal,
3103 "swifterror value should be the second operand when used "
3104 "by stores", SwiftErrorVal, U);
3105 if (auto CallI = dyn_cast<CallInst>(U))
3106 verifySwiftErrorCallSite(const_cast<CallInst*>(CallI), SwiftErrorVal);
3107 if (auto II = dyn_cast<InvokeInst>(U))
3108 verifySwiftErrorCallSite(const_cast<InvokeInst*>(II), SwiftErrorVal);
3109 }
3110}
3111
Victor Hernandez8acf2952009-10-23 21:09:37 +00003112void Verifier::visitAllocaInst(AllocaInst &AI) {
Craig Toppere3dcce92015-08-01 22:20:21 +00003113 SmallPtrSet<Type*, 4> Visited;
Chris Lattner229907c2011-07-18 04:54:35 +00003114 PointerType *PTy = AI.getType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003115 Assert(PTy->getAddressSpace() == 0,
3116 "Allocation instruction pointer not in the generic address space!",
3117 &AI);
David Blaikie5bacf372015-04-24 21:16:07 +00003118 Assert(AI.getAllocatedType()->isSized(&Visited),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003119 "Cannot allocate unsized type", &AI);
3120 Assert(AI.getArraySize()->getType()->isIntegerTy(),
3121 "Alloca array size must have integer type", &AI);
3122 Assert(AI.getAlignment() <= Value::MaximumAlignment,
3123 "huge alignment values are unsupported", &AI);
Reid Klecknera534a382013-12-19 02:14:12 +00003124
Manman Ren9bfd0d02016-04-01 21:41:15 +00003125 if (AI.isSwiftError()) {
3126 verifySwiftErrorValue(&AI);
3127 }
3128
Christopher Lamb55c6d4f2007-12-17 01:00:21 +00003129 visitInstruction(AI);
3130}
3131
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003132void Verifier::visitAtomicCmpXchgInst(AtomicCmpXchgInst &CXI) {
Tim Northovere94a5182014-03-11 10:48:52 +00003133
3134 // FIXME: more conditions???
JF Bastien800f87a2016-04-06 21:19:33 +00003135 Assert(CXI.getSuccessOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003136 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003137 Assert(CXI.getFailureOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003138 "cmpxchg instructions must be atomic.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003139 Assert(CXI.getSuccessOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003140 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003141 Assert(CXI.getFailureOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003142 "cmpxchg instructions cannot be unordered.", &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003143 Assert(!isStrongerThan(CXI.getFailureOrdering(), CXI.getSuccessOrdering()),
3144 "cmpxchg instructions failure argument shall be no stronger than the "
3145 "success argument",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003146 &CXI);
JF Bastien800f87a2016-04-06 21:19:33 +00003147 Assert(CXI.getFailureOrdering() != AtomicOrdering::Release &&
3148 CXI.getFailureOrdering() != AtomicOrdering::AcquireRelease,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003149 "cmpxchg failure ordering cannot include release semantics", &CXI);
Tim Northovere94a5182014-03-11 10:48:52 +00003150
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003151 PointerType *PTy = dyn_cast<PointerType>(CXI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003152 Assert(PTy, "First cmpxchg operand must be a pointer.", &CXI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003153 Type *ElTy = PTy->getElementType();
Philip Reames1960cfd2016-02-19 00:06:41 +00003154 Assert(ElTy->isIntegerTy() || ElTy->isPointerTy(),
3155 "cmpxchg operand must have integer or pointer type",
3156 ElTy, &CXI);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003157 checkAtomicMemAccessSize(ElTy, &CXI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003158 Assert(ElTy == CXI.getOperand(1)->getType(),
3159 "Expected value type does not match pointer operand type!", &CXI,
3160 ElTy);
3161 Assert(ElTy == CXI.getOperand(2)->getType(),
3162 "Stored value type does not match pointer operand type!", &CXI, ElTy);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003163 visitInstruction(CXI);
3164}
3165
3166void Verifier::visitAtomicRMWInst(AtomicRMWInst &RMWI) {
JF Bastien800f87a2016-04-06 21:19:33 +00003167 Assert(RMWI.getOrdering() != AtomicOrdering::NotAtomic,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003168 "atomicrmw instructions must be atomic.", &RMWI);
JF Bastien800f87a2016-04-06 21:19:33 +00003169 Assert(RMWI.getOrdering() != AtomicOrdering::Unordered,
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003170 "atomicrmw instructions cannot be unordered.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003171 PointerType *PTy = dyn_cast<PointerType>(RMWI.getOperand(0)->getType());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003172 Assert(PTy, "First atomicrmw operand must be a pointer.", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003173 Type *ElTy = PTy->getElementType();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003174 Assert(ElTy->isIntegerTy(), "atomicrmw operand must have integer type!",
3175 &RMWI, ElTy);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003176 checkAtomicMemAccessSize(ElTy, &RMWI);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003177 Assert(ElTy == RMWI.getOperand(1)->getType(),
3178 "Argument value type does not match pointer operand type!", &RMWI,
3179 ElTy);
3180 Assert(AtomicRMWInst::FIRST_BINOP <= RMWI.getOperation() &&
3181 RMWI.getOperation() <= AtomicRMWInst::LAST_BINOP,
3182 "Invalid binary operation!", &RMWI);
Eli Friedmanc9a551e2011-07-28 21:48:00 +00003183 visitInstruction(RMWI);
3184}
3185
Eli Friedmanfee02c62011-07-25 23:16:38 +00003186void Verifier::visitFenceInst(FenceInst &FI) {
3187 const AtomicOrdering Ordering = FI.getOrdering();
JF Bastien800f87a2016-04-06 21:19:33 +00003188 Assert(Ordering == AtomicOrdering::Acquire ||
3189 Ordering == AtomicOrdering::Release ||
3190 Ordering == AtomicOrdering::AcquireRelease ||
3191 Ordering == AtomicOrdering::SequentiallyConsistent,
3192 "fence instructions may only have acquire, release, acq_rel, or "
3193 "seq_cst ordering.",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003194 &FI);
Eli Friedmanfee02c62011-07-25 23:16:38 +00003195 visitInstruction(FI);
3196}
3197
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003198void Verifier::visitExtractValueInst(ExtractValueInst &EVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003199 Assert(ExtractValueInst::getIndexedType(EVI.getAggregateOperand()->getType(),
3200 EVI.getIndices()) == EVI.getType(),
3201 "Invalid ExtractValueInst operands!", &EVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003202
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003203 visitInstruction(EVI);
Devang Patel295711f2008-02-19 22:15:16 +00003204}
3205
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003206void Verifier::visitInsertValueInst(InsertValueInst &IVI) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003207 Assert(ExtractValueInst::getIndexedType(IVI.getAggregateOperand()->getType(),
3208 IVI.getIndices()) ==
3209 IVI.getOperand(1)->getType(),
3210 "Invalid InsertValueInst operands!", &IVI);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003211
Dan Gohmanfa1211f2008-07-23 00:34:11 +00003212 visitInstruction(IVI);
3213}
Chris Lattner0e851da2002-04-18 20:37:37 +00003214
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003215static Value *getParentPad(Value *EHPad) {
3216 if (auto *FPI = dyn_cast<FuncletPadInst>(EHPad))
3217 return FPI->getParentPad();
3218
3219 return cast<CatchSwitchInst>(EHPad)->getParentPad();
3220}
3221
David Majnemer85a549d2015-08-11 02:48:30 +00003222void Verifier::visitEHPadPredecessors(Instruction &I) {
3223 assert(I.isEHPad());
Bill Wendlingfae14752011-08-12 20:24:12 +00003224
David Majnemer85a549d2015-08-11 02:48:30 +00003225 BasicBlock *BB = I.getParent();
3226 Function *F = BB->getParent();
3227
3228 Assert(BB != &F->getEntryBlock(), "EH pad cannot be in entry block.", &I);
3229
3230 if (auto *LPI = dyn_cast<LandingPadInst>(&I)) {
3231 // The landingpad instruction defines its parent as a landing pad block. The
3232 // landing pad block may be branched to only by the unwind edge of an
3233 // invoke.
3234 for (BasicBlock *PredBB : predecessors(BB)) {
3235 const auto *II = dyn_cast<InvokeInst>(PredBB->getTerminator());
3236 Assert(II && II->getUnwindDest() == BB && II->getNormalDest() != BB,
3237 "Block containing LandingPadInst must be jumped to "
3238 "only by the unwind edge of an invoke.",
3239 LPI);
3240 }
3241 return;
3242 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003243 if (auto *CPI = dyn_cast<CatchPadInst>(&I)) {
3244 if (!pred_empty(BB))
3245 Assert(BB->getUniquePredecessor() == CPI->getCatchSwitch()->getParent(),
3246 "Block containg CatchPadInst must be jumped to "
3247 "only by its catchswitch.",
3248 CPI);
Joseph Tremouleta9a05cb2016-01-10 04:32:03 +00003249 Assert(BB != CPI->getCatchSwitch()->getUnwindDest(),
3250 "Catchswitch cannot unwind to one of its catchpads",
3251 CPI->getCatchSwitch(), CPI);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003252 return;
3253 }
David Majnemer85a549d2015-08-11 02:48:30 +00003254
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003255 // Verify that each pred has a legal terminator with a legal to/from EH
3256 // pad relationship.
3257 Instruction *ToPad = &I;
3258 Value *ToPadParent = getParentPad(ToPad);
David Majnemer85a549d2015-08-11 02:48:30 +00003259 for (BasicBlock *PredBB : predecessors(BB)) {
3260 TerminatorInst *TI = PredBB->getTerminator();
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003261 Value *FromPad;
David Majnemer8a1c45d2015-12-12 05:38:55 +00003262 if (auto *II = dyn_cast<InvokeInst>(TI)) {
David Majnemer85a549d2015-08-11 02:48:30 +00003263 Assert(II->getUnwindDest() == BB && II->getNormalDest() != BB,
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003264 "EH pad must be jumped to via an unwind edge", ToPad, II);
3265 if (auto Bundle = II->getOperandBundle(LLVMContext::OB_funclet))
3266 FromPad = Bundle->Inputs[0];
3267 else
3268 FromPad = ConstantTokenNone::get(II->getContext());
3269 } else if (auto *CRI = dyn_cast<CleanupReturnInst>(TI)) {
David Majnemer45ebda42016-03-01 18:59:50 +00003270 FromPad = CRI->getOperand(0);
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003271 Assert(FromPad != ToPadParent, "A cleanupret must exit its cleanup", CRI);
3272 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(TI)) {
3273 FromPad = CSI;
3274 } else {
3275 Assert(false, "EH pad must be jumped to via an unwind edge", ToPad, TI);
3276 }
3277
3278 // The edge may exit from zero or more nested pads.
David Majnemerf08579f2016-03-01 01:19:05 +00003279 SmallSet<Value *, 8> Seen;
Joseph Tremoulete28885e2016-01-10 04:28:38 +00003280 for (;; FromPad = getParentPad(FromPad)) {
3281 Assert(FromPad != ToPad,
3282 "EH pad cannot handle exceptions raised within it", FromPad, TI);
3283 if (FromPad == ToPadParent) {
3284 // This is a legal unwind edge.
3285 break;
3286 }
3287 Assert(!isa<ConstantTokenNone>(FromPad),
3288 "A single unwind edge may only enter one EH pad", TI);
David Majnemerf08579f2016-03-01 01:19:05 +00003289 Assert(Seen.insert(FromPad).second,
3290 "EH pad jumps through a cycle of pads", FromPad);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003291 }
David Majnemer85a549d2015-08-11 02:48:30 +00003292 }
3293}
3294
3295void Verifier::visitLandingPadInst(LandingPadInst &LPI) {
Bill Wendlingfae14752011-08-12 20:24:12 +00003296 // The landingpad instruction is ill-formed if it doesn't have any clauses and
3297 // isn't a cleanup.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003298 Assert(LPI.getNumClauses() > 0 || LPI.isCleanup(),
3299 "LandingPadInst needs at least one clause or to be a cleanup.", &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003300
David Majnemer85a549d2015-08-11 02:48:30 +00003301 visitEHPadPredecessors(LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003302
David Majnemer654e1302015-07-31 17:58:14 +00003303 if (!LandingPadResultTy)
3304 LandingPadResultTy = LPI.getType();
3305 else
3306 Assert(LandingPadResultTy == LPI.getType(),
3307 "The landingpad instruction should have a consistent result type "
3308 "inside a function.",
3309 &LPI);
3310
David Majnemer7fddecc2015-06-17 20:52:32 +00003311 Function *F = LPI.getParent()->getParent();
3312 Assert(F->hasPersonalityFn(),
3313 "LandingPadInst needs to be in a function with a personality.", &LPI);
3314
Bill Wendlingfae14752011-08-12 20:24:12 +00003315 // The landingpad instruction must be the first non-PHI instruction in the
3316 // block.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003317 Assert(LPI.getParent()->getLandingPadInst() == &LPI,
3318 "LandingPadInst not the first non-PHI instruction in the block.",
3319 &LPI);
Bill Wendlingfae14752011-08-12 20:24:12 +00003320
Duncan Sands86de1a62011-09-27 16:43:19 +00003321 for (unsigned i = 0, e = LPI.getNumClauses(); i < e; ++i) {
Rafael Espindola4dc5dfc2014-06-04 18:51:31 +00003322 Constant *Clause = LPI.getClause(i);
Duncan Sands68ba8132011-09-27 19:34:22 +00003323 if (LPI.isCatch(i)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003324 Assert(isa<PointerType>(Clause->getType()),
3325 "Catch operand does not have pointer type!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003326 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003327 Assert(LPI.isFilter(i), "Clause is neither catch nor filter!", &LPI);
3328 Assert(isa<ConstantArray>(Clause) || isa<ConstantAggregateZero>(Clause),
3329 "Filter operand is not an array of constants!", &LPI);
Duncan Sands68ba8132011-09-27 19:34:22 +00003330 }
Duncan Sands86de1a62011-09-27 16:43:19 +00003331 }
3332
Bill Wendlingfae14752011-08-12 20:24:12 +00003333 visitInstruction(LPI);
3334}
3335
David Majnemerba6665d2016-08-01 18:06:34 +00003336void Verifier::visitResumeInst(ResumeInst &RI) {
3337 Assert(RI.getFunction()->hasPersonalityFn(),
3338 "ResumeInst needs to be in a function with a personality.", &RI);
3339
3340 if (!LandingPadResultTy)
3341 LandingPadResultTy = RI.getValue()->getType();
3342 else
3343 Assert(LandingPadResultTy == RI.getValue()->getType(),
3344 "The resume instruction should have a consistent result type "
3345 "inside a function.",
3346 &RI);
3347
3348 visitTerminatorInst(RI);
3349}
3350
David Majnemer654e1302015-07-31 17:58:14 +00003351void Verifier::visitCatchPadInst(CatchPadInst &CPI) {
David Majnemer85a549d2015-08-11 02:48:30 +00003352 BasicBlock *BB = CPI.getParent();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003353
David Majnemer654e1302015-07-31 17:58:14 +00003354 Function *F = BB->getParent();
3355 Assert(F->hasPersonalityFn(),
3356 "CatchPadInst needs to be in a function with a personality.", &CPI);
3357
David Majnemer8a1c45d2015-12-12 05:38:55 +00003358 Assert(isa<CatchSwitchInst>(CPI.getParentPad()),
3359 "CatchPadInst needs to be directly nested in a CatchSwitchInst.",
3360 CPI.getParentPad());
3361
David Majnemer654e1302015-07-31 17:58:14 +00003362 // The catchpad instruction must be the first non-PHI instruction in the
3363 // block.
3364 Assert(BB->getFirstNonPHI() == &CPI,
David Majnemer8a1c45d2015-12-12 05:38:55 +00003365 "CatchPadInst not the first non-PHI instruction in the block.", &CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003366
David Majnemerfe2f7f32016-02-29 22:56:36 +00003367 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003368 visitFuncletPadInst(CPI);
David Majnemer654e1302015-07-31 17:58:14 +00003369}
3370
David Majnemer8a1c45d2015-12-12 05:38:55 +00003371void Verifier::visitCatchReturnInst(CatchReturnInst &CatchReturn) {
3372 Assert(isa<CatchPadInst>(CatchReturn.getOperand(0)),
3373 "CatchReturnInst needs to be provided a CatchPad", &CatchReturn,
3374 CatchReturn.getOperand(0));
David Majnemer654e1302015-07-31 17:58:14 +00003375
David Majnemer8a1c45d2015-12-12 05:38:55 +00003376 visitTerminatorInst(CatchReturn);
David Majnemer654e1302015-07-31 17:58:14 +00003377}
3378
3379void Verifier::visitCleanupPadInst(CleanupPadInst &CPI) {
3380 BasicBlock *BB = CPI.getParent();
3381
David Majnemer654e1302015-07-31 17:58:14 +00003382 Function *F = BB->getParent();
3383 Assert(F->hasPersonalityFn(),
3384 "CleanupPadInst needs to be in a function with a personality.", &CPI);
3385
3386 // The cleanuppad instruction must be the first non-PHI instruction in the
3387 // block.
3388 Assert(BB->getFirstNonPHI() == &CPI,
3389 "CleanupPadInst not the first non-PHI instruction in the block.",
3390 &CPI);
3391
David Majnemer8a1c45d2015-12-12 05:38:55 +00003392 auto *ParentPad = CPI.getParentPad();
Joseph Tremoulet06125e52016-01-02 15:24:24 +00003393 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003394 "CleanupPadInst has an invalid parent.", &CPI);
3395
David Majnemerfe2f7f32016-02-29 22:56:36 +00003396 visitEHPadPredecessors(CPI);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003397 visitFuncletPadInst(CPI);
3398}
Joseph Tremoulet8220bcc2015-08-23 00:26:33 +00003399
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003400void Verifier::visitFuncletPadInst(FuncletPadInst &FPI) {
3401 User *FirstUser = nullptr;
3402 Value *FirstUnwindPad = nullptr;
3403 SmallVector<FuncletPadInst *, 8> Worklist({&FPI});
David Majnemerf08579f2016-03-01 01:19:05 +00003404 SmallSet<FuncletPadInst *, 8> Seen;
David Majnemerfe2f7f32016-02-29 22:56:36 +00003405
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003406 while (!Worklist.empty()) {
3407 FuncletPadInst *CurrentPad = Worklist.pop_back_val();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003408 Assert(Seen.insert(CurrentPad).second,
3409 "FuncletPadInst must not be nested within itself", CurrentPad);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003410 Value *UnresolvedAncestorPad = nullptr;
3411 for (User *U : CurrentPad->users()) {
3412 BasicBlock *UnwindDest;
3413 if (auto *CRI = dyn_cast<CleanupReturnInst>(U)) {
3414 UnwindDest = CRI->getUnwindDest();
3415 } else if (auto *CSI = dyn_cast<CatchSwitchInst>(U)) {
3416 // We allow catchswitch unwind to caller to nest
3417 // within an outer pad that unwinds somewhere else,
3418 // because catchswitch doesn't have a nounwind variant.
3419 // See e.g. SimplifyCFGOpt::SimplifyUnreachable.
3420 if (CSI->unwindsToCaller())
3421 continue;
3422 UnwindDest = CSI->getUnwindDest();
3423 } else if (auto *II = dyn_cast<InvokeInst>(U)) {
3424 UnwindDest = II->getUnwindDest();
3425 } else if (isa<CallInst>(U)) {
3426 // Calls which don't unwind may be found inside funclet
3427 // pads that unwind somewhere else. We don't *require*
3428 // such calls to be annotated nounwind.
3429 continue;
3430 } else if (auto *CPI = dyn_cast<CleanupPadInst>(U)) {
3431 // The unwind dest for a cleanup can only be found by
3432 // recursive search. Add it to the worklist, and we'll
3433 // search for its first use that determines where it unwinds.
3434 Worklist.push_back(CPI);
3435 continue;
3436 } else {
3437 Assert(isa<CatchReturnInst>(U), "Bogus funclet pad use", U);
3438 continue;
3439 }
3440
3441 Value *UnwindPad;
3442 bool ExitsFPI;
3443 if (UnwindDest) {
3444 UnwindPad = UnwindDest->getFirstNonPHI();
David Majnemerfe2f7f32016-02-29 22:56:36 +00003445 if (!cast<Instruction>(UnwindPad)->isEHPad())
3446 continue;
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003447 Value *UnwindParent = getParentPad(UnwindPad);
3448 // Ignore unwind edges that don't exit CurrentPad.
3449 if (UnwindParent == CurrentPad)
3450 continue;
3451 // Determine whether the original funclet pad is exited,
3452 // and if we are scanning nested pads determine how many
3453 // of them are exited so we can stop searching their
3454 // children.
3455 Value *ExitedPad = CurrentPad;
3456 ExitsFPI = false;
3457 do {
3458 if (ExitedPad == &FPI) {
3459 ExitsFPI = true;
3460 // Now we can resolve any ancestors of CurrentPad up to
3461 // FPI, but not including FPI since we need to make sure
3462 // to check all direct users of FPI for consistency.
3463 UnresolvedAncestorPad = &FPI;
3464 break;
3465 }
3466 Value *ExitedParent = getParentPad(ExitedPad);
3467 if (ExitedParent == UnwindParent) {
3468 // ExitedPad is the ancestor-most pad which this unwind
3469 // edge exits, so we can resolve up to it, meaning that
3470 // ExitedParent is the first ancestor still unresolved.
3471 UnresolvedAncestorPad = ExitedParent;
3472 break;
3473 }
3474 ExitedPad = ExitedParent;
3475 } while (!isa<ConstantTokenNone>(ExitedPad));
3476 } else {
3477 // Unwinding to caller exits all pads.
3478 UnwindPad = ConstantTokenNone::get(FPI.getContext());
3479 ExitsFPI = true;
3480 UnresolvedAncestorPad = &FPI;
3481 }
3482
3483 if (ExitsFPI) {
3484 // This unwind edge exits FPI. Make sure it agrees with other
3485 // such edges.
3486 if (FirstUser) {
3487 Assert(UnwindPad == FirstUnwindPad, "Unwind edges out of a funclet "
3488 "pad must have the same unwind "
3489 "dest",
3490 &FPI, U, FirstUser);
3491 } else {
3492 FirstUser = U;
3493 FirstUnwindPad = UnwindPad;
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003494 // Record cleanup sibling unwinds for verifySiblingFuncletUnwinds
3495 if (isa<CleanupPadInst>(&FPI) && !isa<ConstantTokenNone>(UnwindPad) &&
3496 getParentPad(UnwindPad) == getParentPad(&FPI))
3497 SiblingFuncletInfo[&FPI] = cast<TerminatorInst>(U);
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003498 }
3499 }
3500 // Make sure we visit all uses of FPI, but for nested pads stop as
3501 // soon as we know where they unwind to.
3502 if (CurrentPad != &FPI)
3503 break;
3504 }
3505 if (UnresolvedAncestorPad) {
3506 if (CurrentPad == UnresolvedAncestorPad) {
3507 // When CurrentPad is FPI itself, we don't mark it as resolved even if
3508 // we've found an unwind edge that exits it, because we need to verify
3509 // all direct uses of FPI.
3510 assert(CurrentPad == &FPI);
3511 continue;
3512 }
3513 // Pop off the worklist any nested pads that we've found an unwind
3514 // destination for. The pads on the worklist are the uncles,
3515 // great-uncles, etc. of CurrentPad. We've found an unwind destination
3516 // for all ancestors of CurrentPad up to but not including
3517 // UnresolvedAncestorPad.
3518 Value *ResolvedPad = CurrentPad;
3519 while (!Worklist.empty()) {
3520 Value *UnclePad = Worklist.back();
3521 Value *AncestorPad = getParentPad(UnclePad);
3522 // Walk ResolvedPad up the ancestor list until we either find the
3523 // uncle's parent or the last resolved ancestor.
3524 while (ResolvedPad != AncestorPad) {
3525 Value *ResolvedParent = getParentPad(ResolvedPad);
3526 if (ResolvedParent == UnresolvedAncestorPad) {
3527 break;
3528 }
3529 ResolvedPad = ResolvedParent;
3530 }
3531 // If the resolved ancestor search didn't find the uncle's parent,
3532 // then the uncle is not yet resolved.
3533 if (ResolvedPad != AncestorPad)
3534 break;
3535 // This uncle is resolved, so pop it from the worklist.
3536 Worklist.pop_back();
3537 }
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003538 }
3539 }
3540
Joseph Tremoulet81e81962016-01-10 04:30:02 +00003541 if (FirstUnwindPad) {
3542 if (auto *CatchSwitch = dyn_cast<CatchSwitchInst>(FPI.getParentPad())) {
3543 BasicBlock *SwitchUnwindDest = CatchSwitch->getUnwindDest();
3544 Value *SwitchUnwindPad;
3545 if (SwitchUnwindDest)
3546 SwitchUnwindPad = SwitchUnwindDest->getFirstNonPHI();
3547 else
3548 SwitchUnwindPad = ConstantTokenNone::get(FPI.getContext());
3549 Assert(SwitchUnwindPad == FirstUnwindPad,
3550 "Unwind edges out of a catch must have the same unwind dest as "
3551 "the parent catchswitch",
3552 &FPI, FirstUser, CatchSwitch);
3553 }
3554 }
3555
3556 visitInstruction(FPI);
David Majnemer654e1302015-07-31 17:58:14 +00003557}
3558
David Majnemer8a1c45d2015-12-12 05:38:55 +00003559void Verifier::visitCatchSwitchInst(CatchSwitchInst &CatchSwitch) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003560 BasicBlock *BB = CatchSwitch.getParent();
3561
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003562 Function *F = BB->getParent();
3563 Assert(F->hasPersonalityFn(),
David Majnemer8a1c45d2015-12-12 05:38:55 +00003564 "CatchSwitchInst needs to be in a function with a personality.",
3565 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003566
David Majnemer8a1c45d2015-12-12 05:38:55 +00003567 // The catchswitch instruction must be the first non-PHI instruction in the
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003568 // block.
David Majnemer8a1c45d2015-12-12 05:38:55 +00003569 Assert(BB->getFirstNonPHI() == &CatchSwitch,
3570 "CatchSwitchInst not the first non-PHI instruction in the block.",
3571 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003572
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003573 auto *ParentPad = CatchSwitch.getParentPad();
3574 Assert(isa<ConstantTokenNone>(ParentPad) || isa<FuncletPadInst>(ParentPad),
3575 "CatchSwitchInst has an invalid parent.", ParentPad);
3576
David Majnemer8a1c45d2015-12-12 05:38:55 +00003577 if (BasicBlock *UnwindDest = CatchSwitch.getUnwindDest()) {
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003578 Instruction *I = UnwindDest->getFirstNonPHI();
David Majnemer8a1c45d2015-12-12 05:38:55 +00003579 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3580 "CatchSwitchInst must unwind to an EH block which is not a "
3581 "landingpad.",
3582 &CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003583
Joseph Tremoulet8ea80862016-01-10 04:31:05 +00003584 // Record catchswitch sibling unwinds for verifySiblingFuncletUnwinds
3585 if (getParentPad(I) == ParentPad)
3586 SiblingFuncletInfo[&CatchSwitch] = &CatchSwitch;
3587 }
David Majnemer8a1c45d2015-12-12 05:38:55 +00003588
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003589 Assert(CatchSwitch.getNumHandlers() != 0,
3590 "CatchSwitchInst cannot have empty handler list", &CatchSwitch);
3591
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003592 for (BasicBlock *Handler : CatchSwitch.handlers()) {
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003593 Assert(isa<CatchPadInst>(Handler->getFirstNonPHI()),
3594 "CatchSwitchInst handlers must be catchpads", &CatchSwitch, Handler);
Joseph Tremouletd425dd12016-01-02 15:50:34 +00003595 }
Joseph Tremoulet131a4622016-01-02 15:25:25 +00003596
David Majnemerfe2f7f32016-02-29 22:56:36 +00003597 visitEHPadPredecessors(CatchSwitch);
David Majnemer8a1c45d2015-12-12 05:38:55 +00003598 visitTerminatorInst(CatchSwitch);
Joseph Tremoulet9ce71f72015-09-03 09:09:43 +00003599}
3600
David Majnemer654e1302015-07-31 17:58:14 +00003601void Verifier::visitCleanupReturnInst(CleanupReturnInst &CRI) {
David Majnemer8a1c45d2015-12-12 05:38:55 +00003602 Assert(isa<CleanupPadInst>(CRI.getOperand(0)),
3603 "CleanupReturnInst needs to be provided a CleanupPad", &CRI,
3604 CRI.getOperand(0));
3605
David Majnemer654e1302015-07-31 17:58:14 +00003606 if (BasicBlock *UnwindDest = CRI.getUnwindDest()) {
3607 Instruction *I = UnwindDest->getFirstNonPHI();
3608 Assert(I->isEHPad() && !isa<LandingPadInst>(I),
3609 "CleanupReturnInst must unwind to an EH block which is not a "
3610 "landingpad.",
3611 &CRI);
3612 }
3613
3614 visitTerminatorInst(CRI);
3615}
3616
Rafael Espindola654320a2012-02-26 02:23:37 +00003617void Verifier::verifyDominatesUse(Instruction &I, unsigned i) {
3618 Instruction *Op = cast<Instruction>(I.getOperand(i));
Rafael Espindola9a167352012-08-17 18:21:28 +00003619 // If the we have an invalid invoke, don't try to compute the dominance.
3620 // We already reject it in the invoke specific checks and the dominance
3621 // computation doesn't handle multiple edges.
3622 if (InvokeInst *II = dyn_cast<InvokeInst>(Op)) {
3623 if (II->getNormalDest() == II->getUnwindDest())
3624 return;
3625 }
Rafael Espindola654320a2012-02-26 02:23:37 +00003626
Michael Kruseff379b62016-03-26 23:32:57 +00003627 // Quick check whether the def has already been encountered in the same block.
3628 // PHI nodes are not checked to prevent accepting preceeding PHIs, because PHI
3629 // uses are defined to happen on the incoming edge, not at the instruction.
Duncan P. N. Exon Smith4ec55f82016-04-08 03:13:22 +00003630 //
3631 // FIXME: If this operand is a MetadataAsValue (wrapping a LocalAsMetadata)
3632 // wrapping an SSA value, assert that we've already encountered it. See
3633 // related FIXME in Mapper::mapLocalAsMetadata in ValueMapper.cpp.
Michael Kruseff379b62016-03-26 23:32:57 +00003634 if (!isa<PHINode>(I) && InstsInThisBlock.count(Op))
3635 return;
3636
Rafael Espindola103c2cf2012-06-01 21:56:26 +00003637 const Use &U = I.getOperandUse(i);
Michael Kruseff379b62016-03-26 23:32:57 +00003638 Assert(DT.dominates(Op, U),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003639 "Instruction does not dominate all uses!", Op, &I);
Rafael Espindola654320a2012-02-26 02:23:37 +00003640}
3641
Artur Pilipenkocca80022015-10-09 17:41:29 +00003642void Verifier::visitDereferenceableMetadata(Instruction& I, MDNode* MD) {
3643 Assert(I.getType()->isPointerTy(), "dereferenceable, dereferenceable_or_null "
3644 "apply only to pointer types", &I);
3645 Assert(isa<LoadInst>(I),
3646 "dereferenceable, dereferenceable_or_null apply only to load"
3647 " instructions, use attributes for calls or invokes", &I);
3648 Assert(MD->getNumOperands() == 1, "dereferenceable, dereferenceable_or_null "
3649 "take one operand!", &I);
3650 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(MD->getOperand(0));
3651 Assert(CI && CI->getType()->isIntegerTy(64), "dereferenceable, "
3652 "dereferenceable_or_null metadata value must be an i64!", &I);
3653}
3654
Misha Brukmanc566ca362004-03-02 00:22:19 +00003655/// verifyInstruction - Verify that an instruction is well formed.
3656///
Chris Lattner069a7952002-06-25 15:56:27 +00003657void Verifier::visitInstruction(Instruction &I) {
Misha Brukmanb1c93172005-04-21 23:48:37 +00003658 BasicBlock *BB = I.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003659 Assert(BB, "Instruction not embedded in basic block!", &I);
Chris Lattner0e851da2002-04-18 20:37:37 +00003660
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003661 if (!isa<PHINode>(I)) { // Check that non-phi nodes are not self referential
Ahmed Charles821b6662014-03-09 04:57:09 +00003662 for (User *U : I.users()) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003663 Assert(U != (User *)&I || !DT.isReachableFromEntry(BB),
3664 "Only PHI nodes may reference their own value!", &I);
Ahmed Charles821b6662014-03-09 04:57:09 +00003665 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003666 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003667
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003668 // Check that void typed values don't have names
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003669 Assert(!I.getType()->isVoidTy() || !I.hasName(),
3670 "Instruction has a name, but provides a void value!", &I);
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003671
Chris Lattner5f126b72004-03-29 00:29:36 +00003672 // Check that the return value of the instruction is either void or a legal
3673 // value type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003674 Assert(I.getType()->isVoidTy() || I.getType()->isFirstClassType(),
3675 "Instruction returns a non-scalar type!", &I);
Chris Lattner5f126b72004-03-29 00:29:36 +00003676
Nick Lewycky93e06a52009-09-27 23:27:42 +00003677 // Check that the instruction doesn't produce metadata. Calls are already
3678 // checked against the callee type.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003679 Assert(!I.getType()->isMetadataTy() || isa<CallInst>(I) || isa<InvokeInst>(I),
3680 "Invalid use of metadata!", &I);
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003681
Chris Lattner0e851da2002-04-18 20:37:37 +00003682 // Check that all uses of the instruction, if they are instructions
3683 // themselves, actually have parent basic blocks. If the use is not an
3684 // instruction, it is an error!
Chandler Carruthcdf47882014-03-09 03:16:01 +00003685 for (Use &U : I.uses()) {
3686 if (Instruction *Used = dyn_cast<Instruction>(U.getUser()))
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003687 Assert(Used->getParent() != nullptr,
3688 "Instruction referencing"
3689 " instruction not embedded in a basic block!",
3690 &I, Used);
Nick Lewycky984161a2009-09-08 02:02:39 +00003691 else {
Chandler Carruthcdf47882014-03-09 03:16:01 +00003692 CheckFailed("Use of instruction is not an instruction!", U);
Nick Lewycky984161a2009-09-08 02:02:39 +00003693 return;
3694 }
Chris Lattner0e851da2002-04-18 20:37:37 +00003695 }
3696
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003697 for (unsigned i = 0, e = I.getNumOperands(); i != e; ++i) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003698 Assert(I.getOperand(i) != nullptr, "Instruction has null operand!", &I);
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003699
3700 // Check to make sure that only first-class-values are operands to
3701 // instructions.
Devang Patel1f00b532008-02-21 01:54:02 +00003702 if (!I.getOperand(i)->getType()->isFirstClassType()) {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00003703 Assert(false, "Instruction operands must be first-class values!", &I);
Devang Patel1f00b532008-02-21 01:54:02 +00003704 }
Nick Lewyckyadbc2842009-05-30 05:06:04 +00003705
Chris Lattner9ece94b2004-03-14 03:23:54 +00003706 if (Function *F = dyn_cast<Function>(I.getOperand(i))) {
Chris Lattnerb7e1ef52006-07-11 20:29:49 +00003707 // Check to make sure that the "address of" an intrinsic function is never
3708 // taken.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003709 Assert(
Justin Lebar9cbc3012016-07-28 23:58:15 +00003710 !F->isIntrinsic() ||
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003711 i == (isa<CallInst>(I) ? e - 1 : isa<InvokeInst>(I) ? e - 3 : 0),
3712 "Cannot take the address of an intrinsic!", &I);
3713 Assert(
3714 !F->isIntrinsic() || isa<CallInst>(I) ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003715 F->getIntrinsicID() == Intrinsic::donothing ||
David Majnemerf93082e2016-08-04 20:30:07 +00003716 F->getIntrinsicID() == Intrinsic::coro_resume ||
3717 F->getIntrinsicID() == Intrinsic::coro_destroy ||
Juergen Ributzkaad2363f2014-10-17 17:39:00 +00003718 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_void ||
Igor Laevsky9570ff92015-02-19 11:28:47 +00003719 F->getIntrinsicID() == Intrinsic::experimental_patchpoint_i64 ||
3720 F->getIntrinsicID() == Intrinsic::experimental_gc_statepoint,
David Majnemerf93082e2016-08-04 20:30:07 +00003721 "Cannot invoke an intrinsic other than donothing, patchpoint, "
3722 "statepoint, coro_resume or coro_destroy",
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003723 &I);
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003724 Assert(F->getParent() == &M, "Referencing function in another module!",
3725 &I, &M, F, F->getParent());
Chris Lattner9ece94b2004-03-14 03:23:54 +00003726 } else if (BasicBlock *OpBB = dyn_cast<BasicBlock>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003727 Assert(OpBB->getParent() == BB->getParent(),
3728 "Referring to a basic block in another function!", &I);
Chris Lattner9ece94b2004-03-14 03:23:54 +00003729 } else if (Argument *OpArg = dyn_cast<Argument>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003730 Assert(OpArg->getParent() == BB->getParent(),
3731 "Referring to an argument in another function!", &I);
Chris Lattner4ff04522007-04-20 21:48:08 +00003732 } else if (GlobalValue *GV = dyn_cast<GlobalValue>(I.getOperand(i))) {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00003733 Assert(GV->getParent() == &M, "Referencing global in another module!", &I,
3734 &M, GV, GV->getParent());
Rafael Espindola654320a2012-02-26 02:23:37 +00003735 } else if (isa<Instruction>(I.getOperand(i))) {
3736 verifyDominatesUse(I, i);
Chris Lattner41eb5cd2006-01-26 00:08:45 +00003737 } else if (isa<InlineAsm>(I.getOperand(i))) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003738 Assert((i + 1 == e && isa<CallInst>(I)) ||
3739 (i + 3 == e && isa<InvokeInst>(I)),
3740 "Cannot take the address of an inline asm!", &I);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003741 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(I.getOperand(i))) {
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003742 if (CE->getType()->isPtrOrPtrVectorTy() ||
3743 !DL.getNonIntegralAddressSpaces().empty()) {
Matt Arsenault24b49c42013-07-31 17:49:08 +00003744 // If we have a ConstantExpr pointer, we need to see if it came from an
Sanjoy Dase1129ee2016-08-02 02:55:57 +00003745 // illegal bitcast. If the datalayout string specifies non-integral
3746 // address spaces then we also need to check for illegal ptrtoint and
3747 // inttoptr expressions.
Duncan P. N. Exon Smith836f0dd2015-12-10 17:56:06 +00003748 visitConstantExprsRecursively(CE);
Matt Arsenault24b49c42013-07-31 17:49:08 +00003749 }
Chris Lattnerdf9779c2003-10-05 17:44:18 +00003750 }
3751 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003752
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003753 if (MDNode *MD = I.getMetadata(LLVMContext::MD_fpmath)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003754 Assert(I.getType()->isFPOrFPVectorTy(),
3755 "fpmath requires a floating point result!", &I);
3756 Assert(MD->getNumOperands() == 1, "fpmath takes one operand!", &I);
Duncan P. N. Exon Smith5bf8fef2014-12-09 18:38:53 +00003757 if (ConstantFP *CFP0 =
3758 mdconst::dyn_extract_or_null<ConstantFP>(MD->getOperand(0))) {
Benjamin Kramer46e38f32016-06-08 10:01:20 +00003759 const APFloat &Accuracy = CFP0->getValueAPF();
Matt Arsenault82f41512016-06-27 19:43:15 +00003760 Assert(&Accuracy.getSemantics() == &APFloat::IEEEsingle,
3761 "fpmath accuracy must have float type", &I);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003762 Assert(Accuracy.isFiniteNonZero() && !Accuracy.isNegative(),
3763 "fpmath accuracy not a positive number!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003764 } else {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003765 Assert(false, "invalid fpmath accuracy!", &I);
Duncan Sands05f4df82012-04-16 16:28:59 +00003766 }
Duncan Sandsaf06b262012-04-10 08:22:43 +00003767 }
3768
Duncan P. N. Exon Smithde36e802014-11-11 21:30:22 +00003769 if (MDNode *Range = I.getMetadata(LLVMContext::MD_range)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003770 Assert(isa<LoadInst>(I) || isa<CallInst>(I) || isa<InvokeInst>(I),
3771 "Ranges are only for loads, calls and invokes!", &I);
Philip Reamesbf9676f2014-10-20 23:52:07 +00003772 visitRangeMetadata(I, Range, I.getType());
3773 }
Rafael Espindolaef9f5502012-03-24 00:14:51 +00003774
Philip Reames0ca58b32014-10-21 20:56:29 +00003775 if (I.getMetadata(LLVMContext::MD_nonnull)) {
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003776 Assert(I.getType()->isPointerTy(), "nonnull applies only to pointer types",
3777 &I);
3778 Assert(isa<LoadInst>(I),
3779 "nonnull applies only to load instructions, use attributes"
3780 " for calls or invokes",
3781 &I);
Philip Reames0ca58b32014-10-21 20:56:29 +00003782 }
3783
Artur Pilipenkocca80022015-10-09 17:41:29 +00003784 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable))
3785 visitDereferenceableMetadata(I, MD);
3786
3787 if (MDNode *MD = I.getMetadata(LLVMContext::MD_dereferenceable_or_null))
3788 visitDereferenceableMetadata(I, MD);
3789
3790 if (MDNode *AlignMD = I.getMetadata(LLVMContext::MD_align)) {
3791 Assert(I.getType()->isPointerTy(), "align applies only to pointer types",
3792 &I);
3793 Assert(isa<LoadInst>(I), "align applies only to load instructions, "
3794 "use attributes for calls or invokes", &I);
3795 Assert(AlignMD->getNumOperands() == 1, "align takes one operand!", &I);
3796 ConstantInt *CI = mdconst::dyn_extract<ConstantInt>(AlignMD->getOperand(0));
3797 Assert(CI && CI->getType()->isIntegerTy(64),
3798 "align metadata value must be an i64!", &I);
3799 uint64_t Align = CI->getZExtValue();
3800 Assert(isPowerOf2_64(Align),
3801 "align metadata value must be a power of 2!", &I);
3802 Assert(Align <= Value::MaximumAlignment,
3803 "alignment is larger that implementation defined limit", &I);
3804 }
3805
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003806 if (MDNode *N = I.getDebugLoc().getAsMDNode()) {
Adrian Prantl541a9c52016-05-06 19:26:47 +00003807 AssertDI(isa<DILocation>(N), "invalid !dbg metadata attachment", &I, N);
Duncan P. N. Exon Smithfc25da12015-03-24 17:32:19 +00003808 visitMDNode(*N);
Duncan P. N. Exon Smitha3bdc322015-03-20 19:26:58 +00003809 }
3810
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00003811 if (auto *DII = dyn_cast<DbgInfoIntrinsic>(&I))
3812 verifyBitPieceExpression(*DII);
3813
Chris Lattnerc9e79d02004-09-29 20:07:45 +00003814 InstsInThisBlock.insert(&I);
Chris Lattnerbb346d02003-05-08 03:47:33 +00003815}
3816
Philip Reames007561a2015-06-26 22:21:52 +00003817/// Allow intrinsics to be verified in different ways.
3818void Verifier::visitIntrinsicCallSite(Intrinsic::ID ID, CallSite CS) {
Philip Reames9818dd72015-06-26 22:04:34 +00003819 Function *IF = CS.getCalledFunction();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003820 Assert(IF->isDeclaration(), "Intrinsic functions should never be defined!",
3821 IF);
Nick Lewycky3fc89802009-09-07 20:44:51 +00003822
Chris Lattner144b6192012-05-27 19:37:05 +00003823 // Verify that the intrinsic prototype lines up with what the .td files
3824 // describe.
3825 FunctionType *IFTy = IF->getFunctionType();
Andrew Tricka2efd992013-10-31 17:18:11 +00003826 bool IsVarArg = IFTy->isVarArg();
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003827
Chris Lattner144b6192012-05-27 19:37:05 +00003828 SmallVector<Intrinsic::IITDescriptor, 8> Table;
3829 getIntrinsicInfoTableEntries(ID, Table);
3830 ArrayRef<Intrinsic::IITDescriptor> TableRef = Table;
Nick Lewycky3fc89802009-09-07 20:44:51 +00003831
Chris Lattner144b6192012-05-27 19:37:05 +00003832 SmallVector<Type *, 4> ArgTys;
Artur Pilipenkobc552272016-06-22 14:56:33 +00003833 Assert(!Intrinsic::matchIntrinsicType(IFTy->getReturnType(),
3834 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003835 "Intrinsic has incorrect return type!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003836 for (unsigned i = 0, e = IFTy->getNumParams(); i != e; ++i)
Artur Pilipenkobc552272016-06-22 14:56:33 +00003837 Assert(!Intrinsic::matchIntrinsicType(IFTy->getParamType(i),
3838 TableRef, ArgTys),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003839 "Intrinsic has incorrect argument type!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003840
3841 // Verify if the intrinsic call matches the vararg property.
3842 if (IsVarArg)
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003843 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003844 "Intrinsic was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003845 else
Artur Pilipenkob68b8212016-06-24 14:47:27 +00003846 Assert(!Intrinsic::matchIntrinsicVarArg(IsVarArg, TableRef),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003847 "Callsite was not defined with variable arguments!", IF);
Andrew Tricka2efd992013-10-31 17:18:11 +00003848
3849 // All descriptors should be absorbed by now.
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003850 Assert(TableRef.empty(), "Intrinsic has too few arguments!", IF);
Chris Lattner144b6192012-05-27 19:37:05 +00003851
3852 // Now that we have the intrinsic ID and the actual argument types (and we
3853 // know they are legal for the intrinsic!) get the intrinsic name through the
3854 // usual means. This allows us to verify the mangling of argument types into
3855 // the name.
Justin Bogner28e1cf62014-03-10 21:22:44 +00003856 const std::string ExpectedName = Intrinsic::getName(ID, ArgTys);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003857 Assert(ExpectedName == IF->getName(),
3858 "Intrinsic name not mangled correctly for type arguments! "
3859 "Should be: " +
3860 ExpectedName,
3861 IF);
Matt Arsenaultc4c92262013-07-20 17:46:00 +00003862
Chris Lattner588096e2009-12-28 09:07:21 +00003863 // If the intrinsic takes MDNode arguments, verify that they are either global
3864 // or are local to *this* function.
Philip Reames007561a2015-06-26 22:21:52 +00003865 for (Value *V : CS.args())
3866 if (auto *MD = dyn_cast<MetadataAsValue>(V))
3867 visitMetadataAsValue(*MD, CS.getCaller());
Victor Hernandez0471abd2009-12-18 20:09:14 +00003868
Gordon Henriksena2f3e132007-09-17 20:30:04 +00003869 switch (ID) {
3870 default:
3871 break;
Gor Nishanov0f303ac2016-08-12 05:45:49 +00003872 case Intrinsic::coro_id: {
Gor Nishanovdce9b022016-08-29 14:34:12 +00003873 auto *InfoArg = CS.getArgOperand(3)->stripPointerCasts();
Gor Nishanov31d8c9a2016-08-06 02:16:35 +00003874 if (isa<ConstantPointerNull>(InfoArg))
3875 break;
3876 auto *GV = dyn_cast<GlobalVariable>(InfoArg);
3877 Assert(GV && GV->isConstant() && GV->hasDefinitiveInitializer(),
3878 "info argument of llvm.coro.begin must refer to an initialized "
3879 "constant");
3880 Constant *Init = GV->getInitializer();
3881 Assert(isa<ConstantStruct>(Init) || isa<ConstantArray>(Init),
3882 "info argument of llvm.coro.begin must refer to either a struct or "
3883 "an array");
3884 break;
3885 }
Chandler Carruth026cc372011-12-12 04:36:02 +00003886 case Intrinsic::ctlz: // llvm.ctlz
3887 case Intrinsic::cttz: // llvm.cttz
Philip Reames9818dd72015-06-26 22:04:34 +00003888 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003889 "is_zero_undef argument of bit counting intrinsics must be a "
3890 "constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003891 CS);
Chandler Carruth026cc372011-12-12 04:36:02 +00003892 break;
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003893 case Intrinsic::dbg_declare: // llvm.dbg.declare
Philip Reames9818dd72015-06-26 22:04:34 +00003894 Assert(isa<MetadataAsValue>(CS.getArgOperand(0)),
3895 "invalid llvm.dbg.declare intrinsic call 1", CS);
3896 visitDbgIntrinsic("declare", cast<DbgDeclareInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00003897 break;
3898 case Intrinsic::dbg_value: // llvm.dbg.value
Philip Reames9818dd72015-06-26 22:04:34 +00003899 visitDbgIntrinsic("value", cast<DbgValueInst>(*CS.getInstruction()));
Duncan P. N. Exon Smith959299e2015-03-15 00:50:57 +00003900 break;
Chris Lattnerdd708342008-11-21 16:42:48 +00003901 case Intrinsic::memcpy:
3902 case Intrinsic::memmove:
Owen Anderson63fbf102015-03-02 09:35:06 +00003903 case Intrinsic::memset: {
Philip Reames9818dd72015-06-26 22:04:34 +00003904 ConstantInt *AlignCI = dyn_cast<ConstantInt>(CS.getArgOperand(3));
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003905 Assert(AlignCI,
3906 "alignment argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003907 CS);
Owen Anderson63fbf102015-03-02 09:35:06 +00003908 const APInt &AlignVal = AlignCI->getValue();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003909 Assert(AlignCI->isZero() || AlignVal.isPowerOf2(),
Philip Reames9818dd72015-06-26 22:04:34 +00003910 "alignment argument of memory intrinsics must be a power of 2", CS);
Pete Cooper67cf9a72015-11-19 05:56:52 +00003911 Assert(isa<ConstantInt>(CS.getArgOperand(4)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003912 "isvolatile argument of memory intrinsics must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003913 CS);
Chris Lattnerecded9a2008-08-23 05:31:10 +00003914 break;
Owen Anderson63fbf102015-03-02 09:35:06 +00003915 }
Bill Wendling05604e02008-08-23 09:46:46 +00003916 case Intrinsic::gcroot:
3917 case Intrinsic::gcwrite:
Chris Lattner25852062008-08-24 20:46:13 +00003918 case Intrinsic::gcread:
3919 if (ID == Intrinsic::gcroot) {
Gordon Henriksenbf40eee2008-10-25 16:28:35 +00003920 AllocaInst *AI =
Philip Reames9818dd72015-06-26 22:04:34 +00003921 dyn_cast<AllocaInst>(CS.getArgOperand(0)->stripPointerCasts());
3922 Assert(AI, "llvm.gcroot parameter #1 must be an alloca.", CS);
3923 Assert(isa<Constant>(CS.getArgOperand(1)),
3924 "llvm.gcroot parameter #2 must be a constant.", CS);
David Blaikie96b48192015-05-11 23:09:25 +00003925 if (!AI->getAllocatedType()->isPointerTy()) {
Philip Reames9818dd72015-06-26 22:04:34 +00003926 Assert(!isa<ConstantPointerNull>(CS.getArgOperand(1)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003927 "llvm.gcroot parameter #1 must either be a pointer alloca, "
3928 "or argument #2 must be a non-null constant.",
Philip Reames9818dd72015-06-26 22:04:34 +00003929 CS);
Talin2e59f142010-09-30 20:23:47 +00003930 }
Chris Lattner25852062008-08-24 20:46:13 +00003931 }
Nick Lewycky3fc89802009-09-07 20:44:51 +00003932
Philip Reames9818dd72015-06-26 22:04:34 +00003933 Assert(CS.getParent()->getParent()->hasGC(),
3934 "Enclosing function does not use GC.", CS);
Chris Lattner25852062008-08-24 20:46:13 +00003935 break;
Duncan Sandsf72ff0c2007-09-29 16:25:54 +00003936 case Intrinsic::init_trampoline:
Philip Reames9818dd72015-06-26 22:04:34 +00003937 Assert(isa<Function>(CS.getArgOperand(1)->stripPointerCasts()),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003938 "llvm.init_trampoline parameter #2 must resolve to a function.",
Philip Reames9818dd72015-06-26 22:04:34 +00003939 CS);
Gordon Henriksen9157c492007-12-25 02:02:10 +00003940 break;
Chris Lattner229f7652008-10-16 06:00:36 +00003941 case Intrinsic::prefetch:
Philip Reames9818dd72015-06-26 22:04:34 +00003942 Assert(isa<ConstantInt>(CS.getArgOperand(1)) &&
3943 isa<ConstantInt>(CS.getArgOperand(2)) &&
3944 cast<ConstantInt>(CS.getArgOperand(1))->getZExtValue() < 2 &&
3945 cast<ConstantInt>(CS.getArgOperand(2))->getZExtValue() < 4,
3946 "invalid arguments to llvm.prefetch", CS);
Chris Lattner229f7652008-10-16 06:00:36 +00003947 break;
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003948 case Intrinsic::stackprotector:
Philip Reames9818dd72015-06-26 22:04:34 +00003949 Assert(isa<AllocaInst>(CS.getArgOperand(1)->stripPointerCasts()),
3950 "llvm.stackprotector parameter #2 must resolve to an alloca.", CS);
Bill Wendlingd8e312d2008-11-18 23:09:31 +00003951 break;
Nick Lewycky9bc89042009-10-13 07:57:33 +00003952 case Intrinsic::lifetime_start:
3953 case Intrinsic::lifetime_end:
3954 case Intrinsic::invariant_start:
Philip Reames9818dd72015-06-26 22:04:34 +00003955 Assert(isa<ConstantInt>(CS.getArgOperand(0)),
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003956 "size argument of memory use markers must be a constant integer",
Philip Reames9818dd72015-06-26 22:04:34 +00003957 CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003958 break;
3959 case Intrinsic::invariant_end:
Philip Reames9818dd72015-06-26 22:04:34 +00003960 Assert(isa<ConstantInt>(CS.getArgOperand(1)),
3961 "llvm.invariant.end parameter #2 must be a constant integer", CS);
Nick Lewycky9bc89042009-10-13 07:57:33 +00003962 break;
Reid Klecknere9b89312015-01-13 00:48:10 +00003963
Reid Kleckner60381792015-07-07 22:25:32 +00003964 case Intrinsic::localescape: {
Philip Reames9818dd72015-06-26 22:04:34 +00003965 BasicBlock *BB = CS.getParent();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003966 Assert(BB == &BB->getParent()->front(),
Reid Kleckner60381792015-07-07 22:25:32 +00003967 "llvm.localescape used outside of entry block", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003968 Assert(!SawFrameEscape,
Reid Kleckner60381792015-07-07 22:25:32 +00003969 "multiple calls to llvm.localescape in one function", CS);
Philip Reames9818dd72015-06-26 22:04:34 +00003970 for (Value *Arg : CS.args()) {
Reid Kleckner3567d272015-04-02 21:13:31 +00003971 if (isa<ConstantPointerNull>(Arg))
3972 continue; // Null values are allowed as placeholders.
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003973 auto *AI = dyn_cast<AllocaInst>(Arg->stripPointerCasts());
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003974 Assert(AI && AI->isStaticAlloca(),
Reid Kleckner60381792015-07-07 22:25:32 +00003975 "llvm.localescape only accepts static allocas", CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003976 }
Philip Reames9818dd72015-06-26 22:04:34 +00003977 FrameEscapeInfo[BB->getParent()].first = CS.getNumArgOperands();
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003978 SawFrameEscape = true;
Reid Klecknere9b89312015-01-13 00:48:10 +00003979 break;
3980 }
Reid Kleckner60381792015-07-07 22:25:32 +00003981 case Intrinsic::localrecover: {
Philip Reames9818dd72015-06-26 22:04:34 +00003982 Value *FnArg = CS.getArgOperand(0)->stripPointerCasts();
Reid Klecknere9b89312015-01-13 00:48:10 +00003983 Function *Fn = dyn_cast<Function>(FnArg);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003984 Assert(Fn && !Fn->isDeclaration(),
Reid Kleckner60381792015-07-07 22:25:32 +00003985 "llvm.localrecover first "
Benjamin Kramerf027ad72015-03-07 21:15:40 +00003986 "argument must be function defined in this module",
Philip Reames9818dd72015-06-26 22:04:34 +00003987 CS);
3988 auto *IdxArg = dyn_cast<ConstantInt>(CS.getArgOperand(2));
Reid Kleckner60381792015-07-07 22:25:32 +00003989 Assert(IdxArg, "idx argument of llvm.localrecover must be a constant int",
Philip Reames9818dd72015-06-26 22:04:34 +00003990 CS);
Reid Klecknercfb9ce52015-03-05 18:26:34 +00003991 auto &Entry = FrameEscapeInfo[Fn];
3992 Entry.second = unsigned(
3993 std::max(uint64_t(Entry.second), IdxArg->getLimitedValue(~0U) + 1));
Reid Klecknere9b89312015-01-13 00:48:10 +00003994 break;
3995 }
3996
Philip Reames1ffa9372015-01-30 23:28:05 +00003997 case Intrinsic::experimental_gc_statepoint:
Philip Reames9818dd72015-06-26 22:04:34 +00003998 Assert(!CS.isInlineAsm(),
3999 "gc.statepoint support for inline assembly unimplemented", CS);
4000 Assert(CS.getParent()->getParent()->hasGC(),
4001 "Enclosing function does not use GC.", CS);
Philip Reames0285c742015-02-03 23:18:47 +00004002
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004003 verifyStatepoint(CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004004 break;
Ramkumar Ramachandra75a4f352015-01-22 20:14:38 +00004005 case Intrinsic::experimental_gc_result: {
Philip Reames9818dd72015-06-26 22:04:34 +00004006 Assert(CS.getParent()->getParent()->hasGC(),
4007 "Enclosing function does not use GC.", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004008 // Are we tied to a statepoint properly?
Philip Reames9818dd72015-06-26 22:04:34 +00004009 CallSite StatepointCS(CS.getArgOperand(0));
Philip Reames76ebd152015-01-07 22:48:01 +00004010 const Function *StatepointFn =
4011 StatepointCS.getInstruction() ? StatepointCS.getCalledFunction() : nullptr;
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004012 Assert(StatepointFn && StatepointFn->isDeclaration() &&
4013 StatepointFn->getIntrinsicID() ==
4014 Intrinsic::experimental_gc_statepoint,
Philip Reames9818dd72015-06-26 22:04:34 +00004015 "gc.result operand #1 must be from a statepoint", CS,
4016 CS.getArgOperand(0));
Philip Reames38303a32014-12-03 19:53:15 +00004017
Philip Reamesb23713a2014-12-03 22:23:24 +00004018 // Assert that result type matches wrapped callee.
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004019 const Value *Target = StatepointCS.getArgument(2);
Craig Toppere3dcce92015-08-01 22:20:21 +00004020 auto *PT = cast<PointerType>(Target->getType());
4021 auto *TargetFuncType = cast<FunctionType>(PT->getElementType());
Philip Reames9818dd72015-06-26 22:04:34 +00004022 Assert(CS.getType() == TargetFuncType->getReturnType(),
4023 "gc.result result type does not match wrapped callee", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004024 break;
4025 }
4026 case Intrinsic::experimental_gc_relocate: {
Philip Reames9818dd72015-06-26 22:04:34 +00004027 Assert(CS.getNumArgOperands() == 3, "wrong number of arguments", CS);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004028
Philip Reames3e2cf532016-01-07 03:32:11 +00004029 Assert(isa<PointerType>(CS.getType()->getScalarType()),
4030 "gc.relocate must return a pointer or a vector of pointers", CS);
4031
Igor Laevsky9570ff92015-02-19 11:28:47 +00004032 // Check that this relocate is correctly tied to the statepoint
4033
4034 // This is case for relocate on the unwinding path of an invoke statepoint
Chen Lid71999e2015-12-26 07:54:32 +00004035 if (LandingPadInst *LandingPad =
4036 dyn_cast<LandingPadInst>(CS.getArgOperand(0))) {
Igor Laevsky9570ff92015-02-19 11:28:47 +00004037
Sanjoy Das5665c992015-05-11 23:47:27 +00004038 const BasicBlock *InvokeBB =
Chen Lid71999e2015-12-26 07:54:32 +00004039 LandingPad->getParent()->getUniquePredecessor();
Igor Laevsky9570ff92015-02-19 11:28:47 +00004040
4041 // Landingpad relocates should have only one predecessor with invoke
4042 // statepoint terminator
Sanjoy Das5665c992015-05-11 23:47:27 +00004043 Assert(InvokeBB, "safepoints should have unique landingpads",
Chen Lid71999e2015-12-26 07:54:32 +00004044 LandingPad->getParent());
Sanjoy Das5665c992015-05-11 23:47:27 +00004045 Assert(InvokeBB->getTerminator(), "safepoint block should be well formed",
4046 InvokeBB);
4047 Assert(isStatepoint(InvokeBB->getTerminator()),
4048 "gc relocate should be linked to a statepoint", InvokeBB);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004049 }
4050 else {
4051 // In all other cases relocate should be tied to the statepoint directly.
4052 // This covers relocates on a normal return path of invoke statepoint and
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004053 // relocates of a call statepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004054 auto Token = CS.getArgOperand(0);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004055 Assert(isa<Instruction>(Token) && isStatepoint(cast<Instruction>(Token)),
Philip Reames9818dd72015-06-26 22:04:34 +00004056 "gc relocate is incorrectly tied to the statepoint", CS, Token);
Igor Laevsky9570ff92015-02-19 11:28:47 +00004057 }
4058
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004059 // Verify rest of the relocate arguments.
Igor Laevsky9570ff92015-02-19 11:28:47 +00004060
Manuel Jacob83eefa62016-01-05 04:03:00 +00004061 ImmutableCallSite StatepointCS(
4062 cast<GCRelocateInst>(*CS.getInstruction()).getStatepoint());
Philip Reames337c4bd2014-12-01 21:18:12 +00004063
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004064 // Both the base and derived must be piped through the safepoint.
Philip Reames9818dd72015-06-26 22:04:34 +00004065 Value* Base = CS.getArgOperand(1);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004066 Assert(isa<ConstantInt>(Base),
Philip Reames9818dd72015-06-26 22:04:34 +00004067 "gc.relocate operand #2 must be integer offset", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004068
Philip Reames9818dd72015-06-26 22:04:34 +00004069 Value* Derived = CS.getArgOperand(2);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004070 Assert(isa<ConstantInt>(Derived),
Philip Reames9818dd72015-06-26 22:04:34 +00004071 "gc.relocate operand #3 must be integer offset", CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004072
4073 const int BaseIndex = cast<ConstantInt>(Base)->getZExtValue();
4074 const int DerivedIndex = cast<ConstantInt>(Derived)->getZExtValue();
4075 // Check the bounds
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004076 Assert(0 <= BaseIndex && BaseIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004077 "gc.relocate: statepoint base index out of bounds", CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004078 Assert(0 <= DerivedIndex && DerivedIndex < (int)StatepointCS.arg_size(),
Philip Reames9818dd72015-06-26 22:04:34 +00004079 "gc.relocate: statepoint derived index out of bounds", CS);
Philip Reames76ebd152015-01-07 22:48:01 +00004080
4081 // Check that BaseIndex and DerivedIndex fall within the 'gc parameters'
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004082 // section of the statepoint's argument.
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004083 Assert(StatepointCS.arg_size() > 0,
4084 "gc.statepoint: insufficient arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004085 Assert(isa<ConstantInt>(StatepointCS.getArgument(3)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004086 "gc.statement: number of call arguments must be constant integer");
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004087 const unsigned NumCallArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004088 cast<ConstantInt>(StatepointCS.getArgument(3))->getZExtValue();
4089 Assert(StatepointCS.arg_size() > NumCallArgs + 5,
Owen Anderson3e7e67b2015-03-10 05:58:21 +00004090 "gc.statepoint: mismatch in number of call arguments");
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004091 Assert(isa<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5)),
Pat Gavlincc0431d2015-05-08 18:07:42 +00004092 "gc.statepoint: number of transition arguments must be "
4093 "a constant integer");
4094 const int NumTransitionArgs =
Sanjoy Dasa1d39ba2015-05-12 23:52:24 +00004095 cast<ConstantInt>(StatepointCS.getArgument(NumCallArgs + 5))
4096 ->getZExtValue();
4097 const int DeoptArgsStart = 4 + NumCallArgs + 1 + NumTransitionArgs + 1;
Pat Gavlincc0431d2015-05-08 18:07:42 +00004098 Assert(isa<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart)),
Owen Andersona3c68fd2015-03-11 06:57:30 +00004099 "gc.statepoint: number of deoptimization arguments must be "
4100 "a constant integer");
Philip Reames76ebd152015-01-07 22:48:01 +00004101 const int NumDeoptArgs =
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004102 cast<ConstantInt>(StatepointCS.getArgument(DeoptArgsStart))
4103 ->getZExtValue();
Pat Gavlincc0431d2015-05-08 18:07:42 +00004104 const int GCParamArgsStart = DeoptArgsStart + 1 + NumDeoptArgs;
Philip Reames76ebd152015-01-07 22:48:01 +00004105 const int GCParamArgsEnd = StatepointCS.arg_size();
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004106 Assert(GCParamArgsStart <= BaseIndex && BaseIndex < GCParamArgsEnd,
4107 "gc.relocate: statepoint base index doesn't fall within the "
4108 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004109 CS);
Benjamin Kramerf027ad72015-03-07 21:15:40 +00004110 Assert(GCParamArgsStart <= DerivedIndex && DerivedIndex < GCParamArgsEnd,
4111 "gc.relocate: statepoint derived index doesn't fall within the "
4112 "'gc parameters' section of the statepoint call",
Philip Reames9818dd72015-06-26 22:04:34 +00004113 CS);
Philip Reames38303a32014-12-03 19:53:15 +00004114
Philip Reames3e2cf532016-01-07 03:32:11 +00004115 // Relocated value must be either a pointer type or vector-of-pointer type,
4116 // but gc_relocate does not need to return the same pointer type as the
4117 // relocated pointer. It can be casted to the correct type later if it's
4118 // desired. However, they must have the same address space and 'vectorness'
Manuel Jacob83eefa62016-01-05 04:03:00 +00004119 GCRelocateInst &Relocate = cast<GCRelocateInst>(*CS.getInstruction());
Philip Reames3e2cf532016-01-07 03:32:11 +00004120 Assert(Relocate.getDerivedPtr()->getType()->getScalarType()->isPointerTy(),
Philip Reames9818dd72015-06-26 22:04:34 +00004121 "gc.relocate: relocated value must be a gc pointer", CS);
Chen Li6d8635a2015-05-18 19:50:14 +00004122
Philip Reames3e2cf532016-01-07 03:32:11 +00004123 auto ResultType = CS.getType();
4124 auto DerivedType = Relocate.getDerivedPtr()->getType();
4125 Assert(ResultType->isVectorTy() == DerivedType->isVectorTy(),
Sanjay Patelbbdab7a2016-01-31 16:32:23 +00004126 "gc.relocate: vector relocates to vector and pointer to pointer",
4127 CS);
4128 Assert(
4129 ResultType->getPointerAddressSpace() ==
4130 DerivedType->getPointerAddressSpace(),
4131 "gc.relocate: relocating a pointer shouldn't change its address space",
4132 CS);
Philip Reames337c4bd2014-12-01 21:18:12 +00004133 break;
4134 }
Reid Kleckner72ba7042015-10-07 00:27:33 +00004135 case Intrinsic::eh_exceptioncode:
Joseph Tremoulet61efbc32015-09-03 09:15:32 +00004136 case Intrinsic::eh_exceptionpointer: {
4137 Assert(isa<CatchPadInst>(CS.getArgOperand(0)),
4138 "eh.exceptionpointer argument must be a catchpad", CS);
4139 break;
4140 }
Philip Reamesf16d7812016-02-09 21:43:12 +00004141 case Intrinsic::masked_load: {
4142 Assert(CS.getType()->isVectorTy(), "masked_load: must return a vector", CS);
4143
4144 Value *Ptr = CS.getArgOperand(0);
4145 //Value *Alignment = CS.getArgOperand(1);
4146 Value *Mask = CS.getArgOperand(2);
4147 Value *PassThru = CS.getArgOperand(3);
4148 Assert(Mask->getType()->isVectorTy(),
4149 "masked_load: mask must be vector", CS);
4150
4151 // DataTy is the overloaded type
4152 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4153 Assert(DataTy == CS.getType(),
4154 "masked_load: return must match pointer type", CS);
4155 Assert(PassThru->getType() == DataTy,
4156 "masked_load: pass through and data type must match", CS);
4157 Assert(Mask->getType()->getVectorNumElements() ==
4158 DataTy->getVectorNumElements(),
4159 "masked_load: vector mask must be same length as data", CS);
4160 break;
4161 }
4162 case Intrinsic::masked_store: {
4163 Value *Val = CS.getArgOperand(0);
4164 Value *Ptr = CS.getArgOperand(1);
4165 //Value *Alignment = CS.getArgOperand(2);
4166 Value *Mask = CS.getArgOperand(3);
4167 Assert(Mask->getType()->isVectorTy(),
4168 "masked_store: mask must be vector", CS);
4169
4170 // DataTy is the overloaded type
4171 Type *DataTy = cast<PointerType>(Ptr->getType())->getElementType();
4172 Assert(DataTy == Val->getType(),
4173 "masked_store: storee must match pointer type", CS);
4174 Assert(Mask->getType()->getVectorNumElements() ==
4175 DataTy->getVectorNumElements(),
4176 "masked_store: vector mask must be same length as data", CS);
4177 break;
4178 }
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004179
Sanjoy Das021de052016-03-31 00:18:46 +00004180 case Intrinsic::experimental_guard: {
4181 Assert(CS.isCall(), "experimental_guard cannot be invoked", CS);
4182 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4183 "experimental_guard must have exactly one "
4184 "\"deopt\" operand bundle");
4185 break;
4186 }
4187
Sanjoy Dasb51325d2016-03-11 19:08:34 +00004188 case Intrinsic::experimental_deoptimize: {
4189 Assert(CS.isCall(), "experimental_deoptimize cannot be invoked", CS);
4190 Assert(CS.countOperandBundlesOfType(LLVMContext::OB_deopt) == 1,
4191 "experimental_deoptimize must have exactly one "
4192 "\"deopt\" operand bundle");
4193 Assert(CS.getType() == CS.getInstruction()->getFunction()->getReturnType(),
4194 "experimental_deoptimize return type must match caller return type");
4195
4196 if (CS.isCall()) {
4197 auto *DeoptCI = CS.getInstruction();
4198 auto *RI = dyn_cast<ReturnInst>(DeoptCI->getNextNode());
4199 Assert(RI,
4200 "calls to experimental_deoptimize must be followed by a return");
4201
4202 if (!CS.getType()->isVoidTy() && RI)
4203 Assert(RI->getReturnValue() == DeoptCI,
4204 "calls to experimental_deoptimize must be followed by a return "
4205 "of the value computed by experimental_deoptimize");
4206 }
4207
4208 break;
4209 }
Philip Reames337c4bd2014-12-01 21:18:12 +00004210 };
Chris Lattner0e851da2002-04-18 20:37:37 +00004211}
4212
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004213/// \brief Carefully grab the subprogram from a local scope.
4214///
4215/// This carefully grabs the subprogram from a local scope, avoiding the
4216/// built-in assertions that would typically fire.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004217static DISubprogram *getSubprogram(Metadata *LocalScope) {
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004218 if (!LocalScope)
4219 return nullptr;
4220
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004221 if (auto *SP = dyn_cast<DISubprogram>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004222 return SP;
4223
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004224 if (auto *LB = dyn_cast<DILexicalBlockBase>(LocalScope))
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004225 return getSubprogram(LB->getRawScope());
4226
4227 // Just return null; broken scope chains are checked elsewhere.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004228 assert(!isa<DILocalScope>(LocalScope) && "Unknown type of local scope");
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004229 return nullptr;
4230}
4231
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004232template <class DbgIntrinsicTy>
4233void Verifier::visitDbgIntrinsic(StringRef Kind, DbgIntrinsicTy &DII) {
4234 auto *MD = cast<MetadataAsValue>(DII.getArgOperand(0))->getMetadata();
Adrian Prantl541a9c52016-05-06 19:26:47 +00004235 AssertDI(isa<ValueAsMetadata>(MD) ||
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004236 (isa<MDNode>(MD) && !cast<MDNode>(MD)->getNumOperands()),
4237 "invalid llvm.dbg." + Kind + " intrinsic address/value", &DII, MD);
Adrian Prantl541a9c52016-05-06 19:26:47 +00004238 AssertDI(isa<DILocalVariable>(DII.getRawVariable()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004239 "invalid llvm.dbg." + Kind + " intrinsic variable", &DII,
4240 DII.getRawVariable());
Adrian Prantl541a9c52016-05-06 19:26:47 +00004241 AssertDI(isa<DIExpression>(DII.getRawExpression()),
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004242 "invalid llvm.dbg." + Kind + " intrinsic expression", &DII,
4243 DII.getRawExpression());
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004244
4245 // Ignore broken !dbg attachments; they're checked elsewhere.
4246 if (MDNode *N = DII.getDebugLoc().getAsMDNode())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004247 if (!isa<DILocation>(N))
Duncan P. N. Exon Smith81f522a2015-04-03 16:54:30 +00004248 return;
4249
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004250 BasicBlock *BB = DII.getParent();
4251 Function *F = BB ? BB->getParent() : nullptr;
4252
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +00004253 // The scopes for variables and !dbg attachments must agree.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004254 DILocalVariable *Var = DII.getVariable();
4255 DILocation *Loc = DII.getDebugLoc();
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004256 Assert(Loc, "llvm.dbg." + Kind + " intrinsic requires a !dbg attachment",
4257 &DII, BB, F);
4258
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004259 DISubprogram *VarSP = getSubprogram(Var->getRawScope());
4260 DISubprogram *LocSP = getSubprogram(Loc->getRawScope());
Duncan P. N. Exon Smithf17f34e2015-04-15 22:15:46 +00004261 if (!VarSP || !LocSP)
4262 return; // Broken scope chains are checked elsewhere.
4263
4264 Assert(VarSP == LocSP, "mismatched subprogram between llvm.dbg." + Kind +
4265 " variable and !dbg attachment",
4266 &DII, BB, F, Var, Var->getScope()->getSubprogram(), Loc,
4267 Loc->getScope()->getSubprogram());
Duncan P. N. Exon Smith166121a2015-03-15 01:21:30 +00004268}
4269
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004270static uint64_t getVariableSize(const DILocalVariable &V) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004271 // Be careful of broken types (checked elsewhere).
4272 const Metadata *RawType = V.getRawType();
4273 while (RawType) {
4274 // Try to get the size directly.
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004275 if (auto *T = dyn_cast<DIType>(RawType))
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004276 if (uint64_t Size = T->getSizeInBits())
4277 return Size;
4278
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004279 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004280 // Look at the base type.
4281 RawType = DT->getRawBaseType();
4282 continue;
4283 }
4284
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004285 // Missing type or size.
4286 break;
4287 }
4288
4289 // Fail gracefully.
4290 return 0;
4291}
4292
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004293void Verifier::verifyBitPieceExpression(const DbgInfoIntrinsic &I) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004294 DILocalVariable *V;
4295 DIExpression *E;
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004296 if (auto *DVI = dyn_cast<DbgValueInst>(&I)) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004297 V = dyn_cast_or_null<DILocalVariable>(DVI->getRawVariable());
4298 E = dyn_cast_or_null<DIExpression>(DVI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004299 } else {
4300 auto *DDI = cast<DbgDeclareInst>(&I);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +00004301 V = dyn_cast_or_null<DILocalVariable>(DDI->getRawVariable());
4302 E = dyn_cast_or_null<DIExpression>(DDI->getRawExpression());
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004303 }
4304
4305 // We don't know whether this intrinsic verified correctly.
4306 if (!V || !E || !E->isValid())
4307 return;
4308
Keno Fischer253a7bd2016-01-15 02:12:38 +00004309 // Nothing to do if this isn't a bit piece expression.
4310 if (!E->isBitPiece())
4311 return;
4312
Adrian Prantlba6ec4b2015-04-29 16:52:17 +00004313 // The frontend helps out GDB by emitting the members of local anonymous
4314 // unions as artificial local variables with shared storage. When SROA splits
4315 // the storage for artificial local variables that are smaller than the entire
4316 // union, the overhang piece will be outside of the allotted space for the
4317 // variable and this check fails.
4318 // FIXME: Remove this check as soon as clang stops doing this; it hides bugs.
4319 if (V->isArtificial())
4320 return;
4321
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004322 // If there's no size, the type is broken, but that should be checked
4323 // elsewhere.
Duncan P. N. Exon Smitha59d3e52016-04-23 21:08:00 +00004324 uint64_t VarSize = getVariableSize(*V);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004325 if (!VarSize)
4326 return;
4327
Keno Fischer253a7bd2016-01-15 02:12:38 +00004328 unsigned PieceSize = E->getBitPieceSize();
4329 unsigned PieceOffset = E->getBitPieceOffset();
4330 Assert(PieceSize + PieceOffset <= VarSize,
4331 "piece is larger than or outside of variable", &I, V, E);
4332 Assert(PieceSize != VarSize, "piece covers entire variable", &I, V, E);
Duncan P. N. Exon Smithc82570b2015-04-13 18:53:11 +00004333}
4334
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004335void Verifier::verifyCompileUnits() {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004336 auto *CUs = M.getNamedMetadata("llvm.dbg.cu");
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004337 SmallPtrSet<const Metadata *, 2> Listed;
4338 if (CUs)
4339 Listed.insert(CUs->op_begin(), CUs->op_end());
4340 Assert(
David Majnemer0a16c222016-08-11 21:15:00 +00004341 all_of(CUVisited,
4342 [&Listed](const Metadata *CU) { return Listed.count(CU); }),
Adrian Prantlfaebbb02016-03-28 21:06:26 +00004343 "All DICompileUnits must be listed in llvm.dbg.cu");
4344 CUVisited.clear();
4345}
4346
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004347void Verifier::verifyDeoptimizeCallingConvs() {
4348 if (DeoptimizeDeclarations.empty())
4349 return;
4350
4351 const Function *First = DeoptimizeDeclarations[0];
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004352 for (auto *F : makeArrayRef(DeoptimizeDeclarations).slice(1)) {
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004353 Assert(First->getCallingConv() == F->getCallingConv(),
4354 "All llvm.experimental.deoptimize declarations must have the same "
4355 "calling convention",
4356 First, F);
Sanjoy Das8d3b1792016-05-12 01:38:08 +00004357 }
Sanjoy Dase0aa4142016-05-12 01:17:38 +00004358}
4359
Chris Lattner0e851da2002-04-18 20:37:37 +00004360//===----------------------------------------------------------------------===//
4361// Implement the public interfaces to this file...
4362//===----------------------------------------------------------------------===//
4363
Chandler Carruth043949d2014-01-19 02:22:18 +00004364bool llvm::verifyFunction(const Function &f, raw_ostream *OS) {
Chandler Carruthbf2b6522014-01-17 11:09:34 +00004365 Function &F = const_cast<Function &>(f);
Misha Brukmanb1c93172005-04-21 23:48:37 +00004366
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004367 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004368 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/true, *f.getParent());
Chandler Carruth043949d2014-01-19 02:22:18 +00004369
4370 // Note that this function's return value is inverted from what you would
4371 // expect of a function called "verify".
4372 return !V.verify(F);
Chris Lattnerd02f08d2002-02-20 17:55:43 +00004373}
4374
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004375bool llvm::verifyModule(const Module &M, raw_ostream *OS,
4376 bool *BrokenDebugInfo) {
Duncan P. N. Exon Smithe8fc69d2016-04-20 16:17:37 +00004377 // Don't use a raw_null_ostream. Printing IR is expensive.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004378 Verifier V(OS, /*ShouldTreatBrokenDebugInfoAsError=*/!BrokenDebugInfo, M);
Nick Lewycky3fc89802009-09-07 20:44:51 +00004379
Chandler Carruth043949d2014-01-19 02:22:18 +00004380 bool Broken = false;
Sanjay Patel1f26bcf2016-02-25 16:44:27 +00004381 for (const Function &F : M)
Peter Collingbournebb738172016-06-06 23:21:27 +00004382 Broken |= !V.verify(F);
Chandler Carruth043949d2014-01-19 02:22:18 +00004383
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004384 Broken |= !V.verify();
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004385 if (BrokenDebugInfo)
4386 *BrokenDebugInfo = V.hasBrokenDebugInfo();
Chandler Carruth043949d2014-01-19 02:22:18 +00004387 // Note that this function's return value is inverted from what you would
4388 // expect of a function called "verify".
Adrian Prantlfe7a3822016-05-09 19:57:15 +00004389 return Broken;
Chris Lattner2f7c9632001-06-06 20:29:01 +00004390}
Chandler Carruth043949d2014-01-19 02:22:18 +00004391
4392namespace {
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004393
Chandler Carruth4d356312014-01-20 11:34:08 +00004394struct VerifierLegacyPass : public FunctionPass {
Chandler Carruth043949d2014-01-19 02:22:18 +00004395 static char ID;
4396
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004397 std::unique_ptr<Verifier> V;
Adrian Prantl94a903e2016-05-25 21:33:20 +00004398 bool FatalErrors = true;
Chandler Carruth043949d2014-01-19 02:22:18 +00004399
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004400 VerifierLegacyPass() : FunctionPass(ID) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004401 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004402 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004403 explicit VerifierLegacyPass(bool FatalErrors)
Adrian Prantl541a9c52016-05-06 19:26:47 +00004404 : FunctionPass(ID),
Adrian Prantl541a9c52016-05-06 19:26:47 +00004405 FatalErrors(FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004406 initializeVerifierLegacyPassPass(*PassRegistry::getPassRegistry());
Chandler Carruth043949d2014-01-19 02:22:18 +00004407 }
4408
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004409 bool doInitialization(Module &M) override {
4410 V = llvm::make_unique<Verifier>(
4411 &dbgs(), /*ShouldTreatBrokenDebugInfoAsError=*/false, M);
4412 return false;
4413 }
4414
Craig Topperf398d7c2014-03-05 06:35:38 +00004415 bool runOnFunction(Function &F) override {
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004416 if (!V->verify(F) && FatalErrors)
Chandler Carruth043949d2014-01-19 02:22:18 +00004417 report_fatal_error("Broken function found, compilation aborted!");
4418
4419 return false;
4420 }
4421
Craig Topperf398d7c2014-03-05 06:35:38 +00004422 bool doFinalization(Module &M) override {
Peter Collingbournebb738172016-06-06 23:21:27 +00004423 bool HasErrors = false;
4424 for (Function &F : M)
4425 if (F.isDeclaration())
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004426 HasErrors |= !V->verify(F);
Peter Collingbournebb738172016-06-06 23:21:27 +00004427
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004428 HasErrors |= !V->verify();
Adrian Prantl94a903e2016-05-25 21:33:20 +00004429 if (FatalErrors) {
4430 if (HasErrors)
4431 report_fatal_error("Broken module found, compilation aborted!");
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004432 assert(!V->hasBrokenDebugInfo() && "Module contains invalid debug info");
Adrian Prantl94a903e2016-05-25 21:33:20 +00004433 }
Chandler Carruth043949d2014-01-19 02:22:18 +00004434
Adrian Prantl94a903e2016-05-25 21:33:20 +00004435 // Strip broken debug info.
Sanjoy Das4b54b7f2016-08-02 01:34:50 +00004436 if (V->hasBrokenDebugInfo()) {
Adrian Prantl94a903e2016-05-25 21:33:20 +00004437 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4438 M.getContext().diagnose(DiagInvalid);
4439 if (!StripDebugInfo(M))
4440 report_fatal_error("Failed to strip malformed debug info");
4441 }
Duncan P. N. Exon Smith6ef5f282014-04-15 16:27:38 +00004442 return false;
4443 }
4444
4445 void getAnalysisUsage(AnalysisUsage &AU) const override {
4446 AU.setPreservesAll();
4447 }
4448};
Eugene Zelenko3e3a0572016-08-13 00:50:41 +00004449
4450} // end anonymous namespace
Chandler Carruth043949d2014-01-19 02:22:18 +00004451
Chandler Carruth4d356312014-01-20 11:34:08 +00004452char VerifierLegacyPass::ID = 0;
4453INITIALIZE_PASS(VerifierLegacyPass, "verify", "Module Verifier", false, false)
Chandler Carruth043949d2014-01-19 02:22:18 +00004454
4455FunctionPass *llvm::createVerifierPass(bool FatalErrors) {
Chandler Carruth4d356312014-01-20 11:34:08 +00004456 return new VerifierLegacyPass(FatalErrors);
Chandler Carruth043949d2014-01-19 02:22:18 +00004457}
4458
Adrian Prantle3656182016-05-09 19:57:29 +00004459char VerifierAnalysis::PassID;
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004460VerifierAnalysis::Result VerifierAnalysis::run(Module &M,
4461 ModuleAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004462 Result Res;
4463 Res.IRBroken = llvm::verifyModule(M, &dbgs(), &Res.DebugInfoBroken);
4464 return Res;
4465}
Chandler Carruth4d356312014-01-20 11:34:08 +00004466
Chandler Carruth164a2aa62016-06-17 00:11:01 +00004467VerifierAnalysis::Result VerifierAnalysis::run(Function &F,
4468 FunctionAnalysisManager &) {
Adrian Prantle3656182016-05-09 19:57:29 +00004469 return { llvm::verifyFunction(F, &dbgs()), false };
4470}
4471
4472PreservedAnalyses VerifierPass::run(Module &M, ModuleAnalysisManager &AM) {
4473 auto Res = AM.getResult<VerifierAnalysis>(M);
4474 if (FatalErrors) {
4475 if (Res.IRBroken)
4476 report_fatal_error("Broken module found, compilation aborted!");
4477 assert(!Res.DebugInfoBroken && "Module contains invalid debug info");
4478 }
4479
4480 // Strip broken debug info.
4481 if (Res.DebugInfoBroken) {
4482 DiagnosticInfoIgnoringInvalidDebugMetadata DiagInvalid(M);
4483 M.getContext().diagnose(DiagInvalid);
4484 if (!StripDebugInfo(M))
4485 report_fatal_error("Failed to strip malformed debug info");
4486 }
Chandler Carruth4d356312014-01-20 11:34:08 +00004487 return PreservedAnalyses::all();
4488}
4489
Adrian Prantle3656182016-05-09 19:57:29 +00004490PreservedAnalyses VerifierPass::run(Function &F, FunctionAnalysisManager &AM) {
4491 auto res = AM.getResult<VerifierAnalysis>(F);
4492 if (res.IRBroken && FatalErrors)
Chandler Carruth4d356312014-01-20 11:34:08 +00004493 report_fatal_error("Broken function found, compilation aborted!");
4494
4495 return PreservedAnalyses::all();
4496}