blob: 38d677d502a750f34a10d38e35c90ce88f009305 [file] [log] [blame]
Dan Gohman113902e2010-04-08 18:47:09 +00001//===-- Lint.cpp - Check for common errors in LLVM IR ---------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This pass statically checks for common and easily-identified constructs
11// which produce undefined or likely unintended behavior in LLVM IR.
12//
13// It is not a guarantee of correctness, in two ways. First, it isn't
14// comprehensive. There are checks which could be done statically which are
15// not yet implemented. Some of these are indicated by TODO comments, but
16// those aren't comprehensive either. Second, many conditions cannot be
17// checked statically. This pass does no dynamic instrumentation, so it
18// can't check for all possible problems.
19//
20// Another limitation is that it assumes all code will be executed. A store
21// through a null pointer in a basic block which is never reached is harmless,
Dan Gohmand3b6e412010-07-06 15:21:57 +000022// but this pass will warn about it anyway. This is the main reason why most
23// of these checks live here instead of in the Verifier pass.
Dan Gohman08833552010-04-22 01:30:05 +000024//
Dan Gohman113902e2010-04-08 18:47:09 +000025// Optimization passes may make conditions that this pass checks for more or
26// less obvious. If an optimization pass appears to be introducing a warning,
27// it may be that the optimization pass is merely exposing an existing
28// condition in the code.
29//
30// This code may be run before instcombine. In many cases, instcombine checks
31// for the same kinds of things and turns instructions with undefined behavior
32// into unreachable (or equivalent). Because of this, this pass makes some
33// effort to look through bitcasts and so on.
34//
35//===----------------------------------------------------------------------===//
36
37#include "llvm/Analysis/Passes.h"
38#include "llvm/Analysis/AliasAnalysis.h"
Dan Gohmanff26d4e2010-05-28 16:21:24 +000039#include "llvm/Analysis/InstructionSimplify.h"
40#include "llvm/Analysis/ConstantFolding.h"
41#include "llvm/Analysis/Dominators.h"
Dan Gohman113902e2010-04-08 18:47:09 +000042#include "llvm/Analysis/Lint.h"
Dan Gohmanff26d4e2010-05-28 16:21:24 +000043#include "llvm/Analysis/Loads.h"
Dan Gohman113902e2010-04-08 18:47:09 +000044#include "llvm/Analysis/ValueTracking.h"
45#include "llvm/Assembly/Writer.h"
46#include "llvm/Target/TargetData.h"
47#include "llvm/Pass.h"
48#include "llvm/PassManager.h"
49#include "llvm/IntrinsicInst.h"
50#include "llvm/Function.h"
51#include "llvm/Support/CallSite.h"
52#include "llvm/Support/Debug.h"
53#include "llvm/Support/InstVisitor.h"
54#include "llvm/Support/raw_ostream.h"
Dan Gohmanbe02b202010-04-09 01:39:53 +000055#include "llvm/ADT/STLExtras.h"
Dan Gohman113902e2010-04-08 18:47:09 +000056using namespace llvm;
57
58namespace {
Dan Gohman5b61b382010-04-30 19:05:00 +000059 namespace MemRef {
60 static unsigned Read = 1;
61 static unsigned Write = 2;
62 static unsigned Callee = 4;
63 static unsigned Branchee = 8;
64 }
65
Dan Gohman113902e2010-04-08 18:47:09 +000066 class Lint : public FunctionPass, public InstVisitor<Lint> {
67 friend class InstVisitor<Lint>;
68
Dan Gohmanbe02b202010-04-09 01:39:53 +000069 void visitFunction(Function &F);
70
Dan Gohman113902e2010-04-08 18:47:09 +000071 void visitCallSite(CallSite CS);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +000072 void visitMemoryReference(Instruction &I, Value *Ptr,
Dan Gohman3da848b2010-10-19 22:54:46 +000073 uint64_t Size, unsigned Align,
Chris Lattnerdb125cf2011-07-18 04:54:35 +000074 Type *Ty, unsigned Flags);
Dan Gohman113902e2010-04-08 18:47:09 +000075
Dan Gohman113902e2010-04-08 18:47:09 +000076 void visitCallInst(CallInst &I);
77 void visitInvokeInst(InvokeInst &I);
78 void visitReturnInst(ReturnInst &I);
79 void visitLoadInst(LoadInst &I);
80 void visitStoreInst(StoreInst &I);
Dan Gohmanbe02b202010-04-09 01:39:53 +000081 void visitXor(BinaryOperator &I);
82 void visitSub(BinaryOperator &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +000083 void visitLShr(BinaryOperator &I);
84 void visitAShr(BinaryOperator &I);
85 void visitShl(BinaryOperator &I);
Dan Gohman113902e2010-04-08 18:47:09 +000086 void visitSDiv(BinaryOperator &I);
87 void visitUDiv(BinaryOperator &I);
88 void visitSRem(BinaryOperator &I);
89 void visitURem(BinaryOperator &I);
90 void visitAllocaInst(AllocaInst &I);
91 void visitVAArgInst(VAArgInst &I);
92 void visitIndirectBrInst(IndirectBrInst &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +000093 void visitExtractElementInst(ExtractElementInst &I);
94 void visitInsertElementInst(InsertElementInst &I);
Dan Gohmanbe02b202010-04-09 01:39:53 +000095 void visitUnreachableInst(UnreachableInst &I);
Dan Gohman113902e2010-04-08 18:47:09 +000096
Dan Gohmanff26d4e2010-05-28 16:21:24 +000097 Value *findValue(Value *V, bool OffsetOk) const;
Dan Gohman17d95962010-05-28 16:45:33 +000098 Value *findValueImpl(Value *V, bool OffsetOk,
99 SmallPtrSet<Value *, 4> &Visited) const;
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000100
Dan Gohman113902e2010-04-08 18:47:09 +0000101 public:
102 Module *Mod;
103 AliasAnalysis *AA;
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000104 DominatorTree *DT;
Dan Gohman113902e2010-04-08 18:47:09 +0000105 TargetData *TD;
106
107 std::string Messages;
108 raw_string_ostream MessagesStr;
109
110 static char ID; // Pass identification, replacement for typeid
Owen Anderson081c34b2010-10-19 17:21:58 +0000111 Lint() : FunctionPass(ID), MessagesStr(Messages) {
112 initializeLintPass(*PassRegistry::getPassRegistry());
113 }
Dan Gohman113902e2010-04-08 18:47:09 +0000114
115 virtual bool runOnFunction(Function &F);
116
117 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
118 AU.setPreservesAll();
119 AU.addRequired<AliasAnalysis>();
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000120 AU.addRequired<DominatorTree>();
Dan Gohman113902e2010-04-08 18:47:09 +0000121 }
122 virtual void print(raw_ostream &O, const Module *M) const {}
123
124 void WriteValue(const Value *V) {
125 if (!V) return;
126 if (isa<Instruction>(V)) {
127 MessagesStr << *V << '\n';
128 } else {
129 WriteAsOperand(MessagesStr, V, true, Mod);
130 MessagesStr << '\n';
131 }
132 }
133
Dan Gohman113902e2010-04-08 18:47:09 +0000134 // CheckFailed - A check failed, so print out the condition and the message
135 // that failed. This provides a nice place to put a breakpoint if you want
136 // to see why something is not correct.
137 void CheckFailed(const Twine &Message,
138 const Value *V1 = 0, const Value *V2 = 0,
139 const Value *V3 = 0, const Value *V4 = 0) {
140 MessagesStr << Message.str() << "\n";
141 WriteValue(V1);
142 WriteValue(V2);
143 WriteValue(V3);
144 WriteValue(V4);
145 }
Dan Gohman113902e2010-04-08 18:47:09 +0000146 };
147}
148
149char Lint::ID = 0;
Owen Anderson2ab36d32010-10-12 19:48:12 +0000150INITIALIZE_PASS_BEGIN(Lint, "lint", "Statically lint-checks LLVM IR",
151 false, true)
152INITIALIZE_PASS_DEPENDENCY(DominatorTree)
153INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
154INITIALIZE_PASS_END(Lint, "lint", "Statically lint-checks LLVM IR",
155 false, true)
Dan Gohman113902e2010-04-08 18:47:09 +0000156
157// Assert - We know that cond should be true, if not print an error message.
158#define Assert(C, M) \
159 do { if (!(C)) { CheckFailed(M); return; } } while (0)
160#define Assert1(C, M, V1) \
161 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
162#define Assert2(C, M, V1, V2) \
163 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
164#define Assert3(C, M, V1, V2, V3) \
165 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
166#define Assert4(C, M, V1, V2, V3, V4) \
167 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
168
169// Lint::run - This is the main Analysis entry point for a
170// function.
171//
172bool Lint::runOnFunction(Function &F) {
173 Mod = F.getParent();
174 AA = &getAnalysis<AliasAnalysis>();
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000175 DT = &getAnalysis<DominatorTree>();
Dan Gohman113902e2010-04-08 18:47:09 +0000176 TD = getAnalysisIfAvailable<TargetData>();
177 visit(F);
178 dbgs() << MessagesStr.str();
Dan Gohmana0f7ff32010-05-26 22:28:53 +0000179 Messages.clear();
Dan Gohman113902e2010-04-08 18:47:09 +0000180 return false;
181}
182
Dan Gohmanbe02b202010-04-09 01:39:53 +0000183void Lint::visitFunction(Function &F) {
184 // This isn't undefined behavior, it's just a little unusual, and it's a
185 // fairly common mistake to neglect to name a function.
186 Assert1(F.hasName() || F.hasLocalLinkage(),
187 "Unusual: Unnamed function with non-local linkage", &F);
Dan Gohman0ce24992010-07-06 15:23:00 +0000188
189 // TODO: Check for irreducible control flow.
Dan Gohman113902e2010-04-08 18:47:09 +0000190}
191
192void Lint::visitCallSite(CallSite CS) {
193 Instruction &I = *CS.getInstruction();
194 Value *Callee = CS.getCalledValue();
195
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000196 visitMemoryReference(I, Callee, AliasAnalysis::UnknownSize,
197 0, 0, MemRef::Callee);
Dan Gohman113902e2010-04-08 18:47:09 +0000198
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000199 if (Function *F = dyn_cast<Function>(findValue(Callee, /*OffsetOk=*/false))) {
Dan Gohman113902e2010-04-08 18:47:09 +0000200 Assert1(CS.getCallingConv() == F->getCallingConv(),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000201 "Undefined behavior: Caller and callee calling convention differ",
202 &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000203
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000204 FunctionType *FT = F->getFunctionType();
Dan Gohman113902e2010-04-08 18:47:09 +0000205 unsigned NumActualArgs = unsigned(CS.arg_end()-CS.arg_begin());
206
207 Assert1(FT->isVarArg() ?
208 FT->getNumParams() <= NumActualArgs :
209 FT->getNumParams() == NumActualArgs,
Dan Gohmanbe02b202010-04-09 01:39:53 +0000210 "Undefined behavior: Call argument count mismatches callee "
211 "argument count", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000212
Dan Gohman545d0062010-07-12 18:02:04 +0000213 Assert1(FT->getReturnType() == I.getType(),
214 "Undefined behavior: Call return type mismatches "
215 "callee return type", &I);
216
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000217 // Check argument types (in case the callee was casted) and attributes.
Dan Gohman0ce24992010-07-06 15:23:00 +0000218 // TODO: Verify that caller and callee attributes are compatible.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000219 Function::arg_iterator PI = F->arg_begin(), PE = F->arg_end();
220 CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
221 for (; AI != AE; ++AI) {
222 Value *Actual = *AI;
223 if (PI != PE) {
224 Argument *Formal = PI++;
225 Assert1(Formal->getType() == Actual->getType(),
226 "Undefined behavior: Call argument type mismatches "
227 "callee parameter type", &I);
Dan Gohman10e77262010-06-01 20:51:40 +0000228
Dan Gohmanc1f1efd2010-12-13 22:53:18 +0000229 // Check that noalias arguments don't alias other arguments. This is
230 // not fully precise because we don't know the sizes of the dereferenced
231 // memory regions.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000232 if (Formal->hasNoAliasAttr() && Actual->getType()->isPointerTy())
Dan Gohmanf3b8c762010-11-11 19:23:51 +0000233 for (CallSite::arg_iterator BI = CS.arg_begin(); BI != AE; ++BI)
Dan Gohman4a2a3ea2010-12-10 20:04:06 +0000234 if (AI != BI && (*BI)->getType()->isPointerTy()) {
235 AliasAnalysis::AliasResult Result = AA->alias(*AI, *BI);
236 Assert1(Result != AliasAnalysis::MustAlias &&
237 Result != AliasAnalysis::PartialAlias,
238 "Unusual: noalias argument aliases another argument", &I);
239 }
Dan Gohman10e77262010-06-01 20:51:40 +0000240
241 // Check that an sret argument points to valid memory.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000242 if (Formal->hasStructRetAttr() && Actual->getType()->isPointerTy()) {
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000243 Type *Ty =
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000244 cast<PointerType>(Formal->getType())->getElementType();
245 visitMemoryReference(I, Actual, AA->getTypeStoreSize(Ty),
246 TD ? TD->getABITypeAlignment(Ty) : 0,
247 Ty, MemRef::Read | MemRef::Write);
248 }
249 }
250 }
Dan Gohman113902e2010-04-08 18:47:09 +0000251 }
252
Dan Gohman113b3e22010-05-26 21:46:36 +0000253 if (CS.isCall() && cast<CallInst>(CS.getInstruction())->isTailCall())
254 for (CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
255 AI != AE; ++AI) {
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000256 Value *Obj = findValue(*AI, /*OffsetOk=*/true);
Dan Gohman078f8592010-05-28 16:34:49 +0000257 Assert1(!isa<AllocaInst>(Obj),
Dan Gohman113b3e22010-05-26 21:46:36 +0000258 "Undefined behavior: Call with \"tail\" keyword references "
Dan Gohman078f8592010-05-28 16:34:49 +0000259 "alloca", &I);
Dan Gohman113b3e22010-05-26 21:46:36 +0000260 }
261
Dan Gohman113902e2010-04-08 18:47:09 +0000262
263 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(&I))
264 switch (II->getIntrinsicID()) {
265 default: break;
266
267 // TODO: Check more intrinsics
268
269 case Intrinsic::memcpy: {
270 MemCpyInst *MCI = cast<MemCpyInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000271 // TODO: If the size is known, use it.
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000272 visitMemoryReference(I, MCI->getDest(), AliasAnalysis::UnknownSize,
273 MCI->getAlignment(), 0,
Dan Gohman13ec30b2010-05-28 17:44:00 +0000274 MemRef::Write);
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000275 visitMemoryReference(I, MCI->getSource(), AliasAnalysis::UnknownSize,
276 MCI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000277 MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000278
Dan Gohmanbe02b202010-04-09 01:39:53 +0000279 // Check that the memcpy arguments don't overlap. The AliasAnalysis API
280 // isn't expressive enough for what we really want to do. Known partial
281 // overlap is not distinguished from the case where nothing is known.
Dan Gohman3da848b2010-10-19 22:54:46 +0000282 uint64_t Size = 0;
Dan Gohman113902e2010-04-08 18:47:09 +0000283 if (const ConstantInt *Len =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000284 dyn_cast<ConstantInt>(findValue(MCI->getLength(),
285 /*OffsetOk=*/false)))
Dan Gohman113902e2010-04-08 18:47:09 +0000286 if (Len->getValue().isIntN(32))
287 Size = Len->getValue().getZExtValue();
288 Assert1(AA->alias(MCI->getSource(), Size, MCI->getDest(), Size) !=
289 AliasAnalysis::MustAlias,
Dan Gohmanbe02b202010-04-09 01:39:53 +0000290 "Undefined behavior: memcpy source and destination overlap", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000291 break;
292 }
293 case Intrinsic::memmove: {
294 MemMoveInst *MMI = cast<MemMoveInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000295 // TODO: If the size is known, use it.
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000296 visitMemoryReference(I, MMI->getDest(), AliasAnalysis::UnknownSize,
297 MMI->getAlignment(), 0,
Dan Gohman13ec30b2010-05-28 17:44:00 +0000298 MemRef::Write);
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000299 visitMemoryReference(I, MMI->getSource(), AliasAnalysis::UnknownSize,
300 MMI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000301 MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000302 break;
303 }
304 case Intrinsic::memset: {
305 MemSetInst *MSI = cast<MemSetInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000306 // TODO: If the size is known, use it.
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000307 visitMemoryReference(I, MSI->getDest(), AliasAnalysis::UnknownSize,
308 MSI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000309 MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000310 break;
311 }
312
313 case Intrinsic::vastart:
Dan Gohmanbe02b202010-04-09 01:39:53 +0000314 Assert1(I.getParent()->getParent()->isVarArg(),
315 "Undefined behavior: va_start called in a non-varargs function",
316 &I);
317
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000318 visitMemoryReference(I, CS.getArgument(0), AliasAnalysis::UnknownSize,
319 0, 0, MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000320 break;
321 case Intrinsic::vacopy:
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000322 visitMemoryReference(I, CS.getArgument(0), AliasAnalysis::UnknownSize,
323 0, 0, MemRef::Write);
324 visitMemoryReference(I, CS.getArgument(1), AliasAnalysis::UnknownSize,
325 0, 0, MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000326 break;
327 case Intrinsic::vaend:
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000328 visitMemoryReference(I, CS.getArgument(0), AliasAnalysis::UnknownSize,
329 0, 0, MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000330 break;
Dan Gohman882ddb42010-05-26 22:21:25 +0000331
332 case Intrinsic::stackrestore:
333 // Stackrestore doesn't read or write memory, but it sets the
334 // stack pointer, which the compiler may read from or write to
335 // at any time, so check it for both readability and writeability.
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000336 visitMemoryReference(I, CS.getArgument(0), AliasAnalysis::UnknownSize,
337 0, 0, MemRef::Read | MemRef::Write);
Dan Gohman882ddb42010-05-26 22:21:25 +0000338 break;
Dan Gohman113902e2010-04-08 18:47:09 +0000339 }
340}
341
342void Lint::visitCallInst(CallInst &I) {
343 return visitCallSite(&I);
344}
345
346void Lint::visitInvokeInst(InvokeInst &I) {
347 return visitCallSite(&I);
348}
349
350void Lint::visitReturnInst(ReturnInst &I) {
351 Function *F = I.getParent()->getParent();
352 Assert1(!F->doesNotReturn(),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000353 "Unusual: Return statement in function with noreturn attribute",
354 &I);
Dan Gohman292fc872010-05-28 04:33:42 +0000355
356 if (Value *V = I.getReturnValue()) {
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000357 Value *Obj = findValue(V, /*OffsetOk=*/true);
Dan Gohman078f8592010-05-28 16:34:49 +0000358 Assert1(!isa<AllocaInst>(Obj),
359 "Unusual: Returning alloca value", &I);
Dan Gohman292fc872010-05-28 04:33:42 +0000360 }
Dan Gohman113902e2010-04-08 18:47:09 +0000361}
362
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000363// TODO: Check that the reference is in bounds.
Dan Gohman0ce24992010-07-06 15:23:00 +0000364// TODO: Check readnone/readonly function attributes.
Dan Gohman113902e2010-04-08 18:47:09 +0000365void Lint::visitMemoryReference(Instruction &I,
Dan Gohman3da848b2010-10-19 22:54:46 +0000366 Value *Ptr, uint64_t Size, unsigned Align,
Chris Lattnerdb125cf2011-07-18 04:54:35 +0000367 Type *Ty, unsigned Flags) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000368 // If no memory is being referenced, it doesn't matter if the pointer
369 // is valid.
370 if (Size == 0)
371 return;
372
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000373 Value *UnderlyingObject = findValue(Ptr, /*OffsetOk=*/true);
Dan Gohmanbe02b202010-04-09 01:39:53 +0000374 Assert1(!isa<ConstantPointerNull>(UnderlyingObject),
375 "Undefined behavior: Null pointer dereference", &I);
376 Assert1(!isa<UndefValue>(UnderlyingObject),
377 "Undefined behavior: Undef pointer dereference", &I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000378 Assert1(!isa<ConstantInt>(UnderlyingObject) ||
379 !cast<ConstantInt>(UnderlyingObject)->isAllOnesValue(),
380 "Unusual: All-ones pointer dereference", &I);
381 Assert1(!isa<ConstantInt>(UnderlyingObject) ||
382 !cast<ConstantInt>(UnderlyingObject)->isOne(),
383 "Unusual: Address one pointer dereference", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000384
Dan Gohman5b61b382010-04-30 19:05:00 +0000385 if (Flags & MemRef::Write) {
386 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(UnderlyingObject))
387 Assert1(!GV->isConstant(),
388 "Undefined behavior: Write to read-only memory", &I);
389 Assert1(!isa<Function>(UnderlyingObject) &&
390 !isa<BlockAddress>(UnderlyingObject),
391 "Undefined behavior: Write to text section", &I);
392 }
393 if (Flags & MemRef::Read) {
394 Assert1(!isa<Function>(UnderlyingObject),
395 "Unusual: Load from function body", &I);
396 Assert1(!isa<BlockAddress>(UnderlyingObject),
397 "Undefined behavior: Load from block address", &I);
398 }
399 if (Flags & MemRef::Callee) {
400 Assert1(!isa<BlockAddress>(UnderlyingObject),
401 "Undefined behavior: Call to block address", &I);
402 }
403 if (Flags & MemRef::Branchee) {
404 Assert1(!isa<Constant>(UnderlyingObject) ||
405 isa<BlockAddress>(UnderlyingObject),
406 "Undefined behavior: Branch to non-blockaddress", &I);
407 }
408
Dan Gohman113902e2010-04-08 18:47:09 +0000409 if (TD) {
410 if (Align == 0 && Ty) Align = TD->getABITypeAlignment(Ty);
411
412 if (Align != 0) {
413 unsigned BitWidth = TD->getTypeSizeInBits(Ptr->getType());
414 APInt Mask = APInt::getAllOnesValue(BitWidth),
415 KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
416 ComputeMaskedBits(Ptr, Mask, KnownZero, KnownOne, TD);
417 Assert1(!(KnownOne & APInt::getLowBitsSet(BitWidth, Log2_32(Align))),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000418 "Undefined behavior: Memory reference address is misaligned", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000419 }
420 }
421}
422
423void Lint::visitLoadInst(LoadInst &I) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000424 visitMemoryReference(I, I.getPointerOperand(),
425 AA->getTypeStoreSize(I.getType()), I.getAlignment(),
426 I.getType(), MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000427}
428
429void Lint::visitStoreInst(StoreInst &I) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000430 visitMemoryReference(I, I.getPointerOperand(),
431 AA->getTypeStoreSize(I.getOperand(0)->getType()),
432 I.getAlignment(),
433 I.getOperand(0)->getType(), MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000434}
435
Dan Gohmanbe02b202010-04-09 01:39:53 +0000436void Lint::visitXor(BinaryOperator &I) {
437 Assert1(!isa<UndefValue>(I.getOperand(0)) ||
438 !isa<UndefValue>(I.getOperand(1)),
439 "Undefined result: xor(undef, undef)", &I);
440}
441
442void Lint::visitSub(BinaryOperator &I) {
443 Assert1(!isa<UndefValue>(I.getOperand(0)) ||
444 !isa<UndefValue>(I.getOperand(1)),
445 "Undefined result: sub(undef, undef)", &I);
446}
447
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000448void Lint::visitLShr(BinaryOperator &I) {
449 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000450 dyn_cast<ConstantInt>(findValue(I.getOperand(1), /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000451 Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000452 "Undefined result: Shift count out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000453}
454
455void Lint::visitAShr(BinaryOperator &I) {
456 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000457 dyn_cast<ConstantInt>(findValue(I.getOperand(1), /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000458 Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000459 "Undefined result: Shift count out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000460}
461
462void Lint::visitShl(BinaryOperator &I) {
463 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000464 dyn_cast<ConstantInt>(findValue(I.getOperand(1), /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000465 Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000466 "Undefined result: Shift count out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000467}
468
Dan Gohman113902e2010-04-08 18:47:09 +0000469static bool isZero(Value *V, TargetData *TD) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000470 // Assume undef could be zero.
471 if (isa<UndefValue>(V)) return true;
472
Dan Gohman113902e2010-04-08 18:47:09 +0000473 unsigned BitWidth = cast<IntegerType>(V->getType())->getBitWidth();
474 APInt Mask = APInt::getAllOnesValue(BitWidth),
475 KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
476 ComputeMaskedBits(V, Mask, KnownZero, KnownOne, TD);
477 return KnownZero.isAllOnesValue();
478}
479
480void Lint::visitSDiv(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000481 Assert1(!isZero(I.getOperand(1), TD),
482 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000483}
484
485void Lint::visitUDiv(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000486 Assert1(!isZero(I.getOperand(1), TD),
487 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000488}
489
490void Lint::visitSRem(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000491 Assert1(!isZero(I.getOperand(1), TD),
492 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000493}
494
495void Lint::visitURem(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000496 Assert1(!isZero(I.getOperand(1), TD),
497 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000498}
499
500void Lint::visitAllocaInst(AllocaInst &I) {
501 if (isa<ConstantInt>(I.getArraySize()))
502 // This isn't undefined behavior, it's just an obvious pessimization.
503 Assert1(&I.getParent()->getParent()->getEntryBlock() == I.getParent(),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000504 "Pessimization: Static alloca outside of entry block", &I);
Dan Gohman0ce24992010-07-06 15:23:00 +0000505
506 // TODO: Check for an unusual size (MSB set?)
Dan Gohman113902e2010-04-08 18:47:09 +0000507}
508
509void Lint::visitVAArgInst(VAArgInst &I) {
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000510 visitMemoryReference(I, I.getOperand(0), AliasAnalysis::UnknownSize, 0, 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000511 MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000512}
513
514void Lint::visitIndirectBrInst(IndirectBrInst &I) {
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000515 visitMemoryReference(I, I.getAddress(), AliasAnalysis::UnknownSize, 0, 0,
516 MemRef::Branchee);
Dan Gohmana8afb2a2010-08-02 23:06:43 +0000517
518 Assert1(I.getNumDestinations() != 0,
519 "Undefined behavior: indirectbr with no destinations", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000520}
521
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000522void Lint::visitExtractElementInst(ExtractElementInst &I) {
523 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000524 dyn_cast<ConstantInt>(findValue(I.getIndexOperand(),
525 /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000526 Assert1(CI->getValue().ult(I.getVectorOperandType()->getNumElements()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000527 "Undefined result: extractelement index out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000528}
529
530void Lint::visitInsertElementInst(InsertElementInst &I) {
531 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000532 dyn_cast<ConstantInt>(findValue(I.getOperand(2),
533 /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000534 Assert1(CI->getValue().ult(I.getType()->getNumElements()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000535 "Undefined result: insertelement index out of range", &I);
536}
537
538void Lint::visitUnreachableInst(UnreachableInst &I) {
539 // This isn't undefined behavior, it's merely suspicious.
540 Assert1(&I == I.getParent()->begin() ||
541 prior(BasicBlock::iterator(&I))->mayHaveSideEffects(),
542 "Unusual: unreachable immediately preceded by instruction without "
543 "side effects", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000544}
545
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000546/// findValue - Look through bitcasts and simple memory reference patterns
547/// to identify an equivalent, but more informative, value. If OffsetOk
548/// is true, look through getelementptrs with non-zero offsets too.
549///
550/// Most analysis passes don't require this logic, because instcombine
551/// will simplify most of these kinds of things away. But it's a goal of
552/// this Lint pass to be useful even on non-optimized IR.
553Value *Lint::findValue(Value *V, bool OffsetOk) const {
Dan Gohman17d95962010-05-28 16:45:33 +0000554 SmallPtrSet<Value *, 4> Visited;
555 return findValueImpl(V, OffsetOk, Visited);
556}
557
558/// findValueImpl - Implementation helper for findValue.
559Value *Lint::findValueImpl(Value *V, bool OffsetOk,
560 SmallPtrSet<Value *, 4> &Visited) const {
561 // Detect self-referential values.
562 if (!Visited.insert(V))
563 return UndefValue::get(V->getType());
564
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000565 // TODO: Look through sext or zext cast, when the result is known to
566 // be interpreted as signed or unsigned, respectively.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000567 // TODO: Look through eliminable cast pairs.
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000568 // TODO: Look through calls with unique return values.
569 // TODO: Look through vector insert/extract/shuffle.
Dan Gohmanbd1801b2011-01-24 18:53:32 +0000570 V = OffsetOk ? GetUnderlyingObject(V, TD) : V->stripPointerCasts();
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000571 if (LoadInst *L = dyn_cast<LoadInst>(V)) {
572 BasicBlock::iterator BBI = L;
573 BasicBlock *BB = L->getParent();
Dan Gohman13ec30b2010-05-28 17:44:00 +0000574 SmallPtrSet<BasicBlock *, 4> VisitedBlocks;
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000575 for (;;) {
Dan Gohman13ec30b2010-05-28 17:44:00 +0000576 if (!VisitedBlocks.insert(BB)) break;
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000577 if (Value *U = FindAvailableLoadedValue(L->getPointerOperand(),
578 BB, BBI, 6, AA))
Dan Gohman17d95962010-05-28 16:45:33 +0000579 return findValueImpl(U, OffsetOk, Visited);
Dan Gohman13ec30b2010-05-28 17:44:00 +0000580 if (BBI != BB->begin()) break;
581 BB = BB->getUniquePredecessor();
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000582 if (!BB) break;
583 BBI = BB->end();
584 }
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000585 } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
Duncan Sandsff103412010-11-17 04:30:22 +0000586 if (Value *W = PN->hasConstantValue())
Duncan Sands23a19572010-11-17 10:23:23 +0000587 if (W != V)
588 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000589 } else if (CastInst *CI = dyn_cast<CastInst>(V)) {
590 if (CI->isNoopCast(TD ? TD->getIntPtrType(V->getContext()) :
591 Type::getInt64Ty(V->getContext())))
Dan Gohman17d95962010-05-28 16:45:33 +0000592 return findValueImpl(CI->getOperand(0), OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000593 } else if (ExtractValueInst *Ex = dyn_cast<ExtractValueInst>(V)) {
594 if (Value *W = FindInsertedValue(Ex->getAggregateOperand(),
Jay Foadfc6d3a42011-07-13 10:26:04 +0000595 Ex->getIndices()))
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000596 if (W != V)
Dan Gohman17d95962010-05-28 16:45:33 +0000597 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000598 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
599 // Same as above, but for ConstantExpr instead of Instruction.
600 if (Instruction::isCast(CE->getOpcode())) {
601 if (CastInst::isNoopCast(Instruction::CastOps(CE->getOpcode()),
602 CE->getOperand(0)->getType(),
603 CE->getType(),
604 TD ? TD->getIntPtrType(V->getContext()) :
605 Type::getInt64Ty(V->getContext())))
606 return findValueImpl(CE->getOperand(0), OffsetOk, Visited);
607 } else if (CE->getOpcode() == Instruction::ExtractValue) {
Jay Foadd30aa5a2011-04-13 15:22:40 +0000608 ArrayRef<unsigned> Indices = CE->getIndices();
Jay Foadfc6d3a42011-07-13 10:26:04 +0000609 if (Value *W = FindInsertedValue(CE->getOperand(0), Indices))
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000610 if (W != V)
611 return findValueImpl(W, OffsetOk, Visited);
612 }
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000613 }
614
615 // As a last resort, try SimplifyInstruction or constant folding.
616 if (Instruction *Inst = dyn_cast<Instruction>(V)) {
Duncan Sandsff103412010-11-17 04:30:22 +0000617 if (Value *W = SimplifyInstruction(Inst, TD, DT))
Duncan Sandsd261dc62010-11-17 08:35:29 +0000618 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000619 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
620 if (Value *W = ConstantFoldConstantExpression(CE, TD))
621 if (W != V)
Dan Gohman17d95962010-05-28 16:45:33 +0000622 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000623 }
624
625 return V;
626}
627
Dan Gohman113902e2010-04-08 18:47:09 +0000628//===----------------------------------------------------------------------===//
629// Implement the public interfaces to this file...
630//===----------------------------------------------------------------------===//
631
632FunctionPass *llvm::createLintPass() {
633 return new Lint();
634}
635
636/// lintFunction - Check a function for errors, printing messages on stderr.
637///
638void llvm::lintFunction(const Function &f) {
639 Function &F = const_cast<Function&>(f);
640 assert(!F.isDeclaration() && "Cannot lint external functions");
641
642 FunctionPassManager FPM(F.getParent());
643 Lint *V = new Lint();
644 FPM.add(V);
645 FPM.run(F);
646}
647
648/// lintModule - Check a module for errors, printing messages on stderr.
Dan Gohman113902e2010-04-08 18:47:09 +0000649///
Dan Gohmana0f7ff32010-05-26 22:28:53 +0000650void llvm::lintModule(const Module &M) {
Dan Gohman113902e2010-04-08 18:47:09 +0000651 PassManager PM;
652 Lint *V = new Lint();
653 PM.add(V);
654 PM.run(const_cast<Module&>(M));
Dan Gohman113902e2010-04-08 18:47:09 +0000655}