blob: b1aa4ca6884d21fd38294d82ef9ddc7b3e974db6 [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,
73 unsigned Size, unsigned Align,
Dan Gohman5b61b382010-04-30 19:05:00 +000074 const 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
111 Lint() : FunctionPass(&ID), MessagesStr(Messages) {}
112
113 virtual bool runOnFunction(Function &F);
114
115 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
116 AU.setPreservesAll();
117 AU.addRequired<AliasAnalysis>();
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000118 AU.addRequired<DominatorTree>();
Dan Gohman113902e2010-04-08 18:47:09 +0000119 }
120 virtual void print(raw_ostream &O, const Module *M) const {}
121
122 void WriteValue(const Value *V) {
123 if (!V) return;
124 if (isa<Instruction>(V)) {
125 MessagesStr << *V << '\n';
126 } else {
127 WriteAsOperand(MessagesStr, V, true, Mod);
128 MessagesStr << '\n';
129 }
130 }
131
132 void WriteType(const Type *T) {
133 if (!T) return;
134 MessagesStr << ' ';
135 WriteTypeSymbolic(MessagesStr, T, Mod);
136 }
137
138 // CheckFailed - A check failed, so print out the condition and the message
139 // that failed. This provides a nice place to put a breakpoint if you want
140 // to see why something is not correct.
141 void CheckFailed(const Twine &Message,
142 const Value *V1 = 0, const Value *V2 = 0,
143 const Value *V3 = 0, const Value *V4 = 0) {
144 MessagesStr << Message.str() << "\n";
145 WriteValue(V1);
146 WriteValue(V2);
147 WriteValue(V3);
148 WriteValue(V4);
149 }
150
151 void CheckFailed(const Twine &Message, const Value *V1,
152 const Type *T2, const Value *V3 = 0) {
153 MessagesStr << Message.str() << "\n";
154 WriteValue(V1);
155 WriteType(T2);
156 WriteValue(V3);
157 }
158
159 void CheckFailed(const Twine &Message, const Type *T1,
160 const Type *T2 = 0, const Type *T3 = 0) {
161 MessagesStr << Message.str() << "\n";
162 WriteType(T1);
163 WriteType(T2);
164 WriteType(T3);
165 }
166 };
167}
168
169char Lint::ID = 0;
170static RegisterPass<Lint>
171X("lint", "Statically lint-checks LLVM IR", false, true);
172
173// Assert - We know that cond should be true, if not print an error message.
174#define Assert(C, M) \
175 do { if (!(C)) { CheckFailed(M); return; } } while (0)
176#define Assert1(C, M, V1) \
177 do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
178#define Assert2(C, M, V1, V2) \
179 do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
180#define Assert3(C, M, V1, V2, V3) \
181 do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
182#define Assert4(C, M, V1, V2, V3, V4) \
183 do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
184
185// Lint::run - This is the main Analysis entry point for a
186// function.
187//
188bool Lint::runOnFunction(Function &F) {
189 Mod = F.getParent();
190 AA = &getAnalysis<AliasAnalysis>();
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000191 DT = &getAnalysis<DominatorTree>();
Dan Gohman113902e2010-04-08 18:47:09 +0000192 TD = getAnalysisIfAvailable<TargetData>();
193 visit(F);
194 dbgs() << MessagesStr.str();
Dan Gohmana0f7ff32010-05-26 22:28:53 +0000195 Messages.clear();
Dan Gohman113902e2010-04-08 18:47:09 +0000196 return false;
197}
198
Dan Gohmanbe02b202010-04-09 01:39:53 +0000199void Lint::visitFunction(Function &F) {
200 // This isn't undefined behavior, it's just a little unusual, and it's a
201 // fairly common mistake to neglect to name a function.
202 Assert1(F.hasName() || F.hasLocalLinkage(),
203 "Unusual: Unnamed function with non-local linkage", &F);
Dan Gohman113902e2010-04-08 18:47:09 +0000204}
205
206void Lint::visitCallSite(CallSite CS) {
207 Instruction &I = *CS.getInstruction();
208 Value *Callee = CS.getCalledValue();
209
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000210 visitMemoryReference(I, Callee, ~0u, 0, 0, MemRef::Callee);
Dan Gohman113902e2010-04-08 18:47:09 +0000211
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000212 if (Function *F = dyn_cast<Function>(findValue(Callee, /*OffsetOk=*/false))) {
Dan Gohman113902e2010-04-08 18:47:09 +0000213 Assert1(CS.getCallingConv() == F->getCallingConv(),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000214 "Undefined behavior: Caller and callee calling convention differ",
215 &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000216
217 const FunctionType *FT = F->getFunctionType();
218 unsigned NumActualArgs = unsigned(CS.arg_end()-CS.arg_begin());
219
220 Assert1(FT->isVarArg() ?
221 FT->getNumParams() <= NumActualArgs :
222 FT->getNumParams() == NumActualArgs,
Dan Gohmanbe02b202010-04-09 01:39:53 +0000223 "Undefined behavior: Call argument count mismatches callee "
224 "argument count", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000225
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000226 // Check argument types (in case the callee was casted) and attributes.
227 Function::arg_iterator PI = F->arg_begin(), PE = F->arg_end();
228 CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
229 for (; AI != AE; ++AI) {
230 Value *Actual = *AI;
231 if (PI != PE) {
232 Argument *Formal = PI++;
233 Assert1(Formal->getType() == Actual->getType(),
234 "Undefined behavior: Call argument type mismatches "
235 "callee parameter type", &I);
Dan Gohman10e77262010-06-01 20:51:40 +0000236
237 // Check that noalias arguments don't alias other arguments. The
238 // AliasAnalysis API isn't expressive enough for what we really want
239 // to do. Known partial overlap is not distinguished from the case
240 // where nothing is known.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000241 if (Formal->hasNoAliasAttr() && Actual->getType()->isPointerTy())
Dan Gohman10e77262010-06-01 20:51:40 +0000242 for (CallSite::arg_iterator BI = CS.arg_begin(); BI != AE; ++BI) {
243 Assert1(AI == BI ||
244 AA->alias(*AI, ~0u, *BI, ~0u) != AliasAnalysis::MustAlias,
245 "Unusual: noalias argument aliases another argument", &I);
246 }
247
248 // Check that an sret argument points to valid memory.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000249 if (Formal->hasStructRetAttr() && Actual->getType()->isPointerTy()) {
250 const Type *Ty =
251 cast<PointerType>(Formal->getType())->getElementType();
252 visitMemoryReference(I, Actual, AA->getTypeStoreSize(Ty),
253 TD ? TD->getABITypeAlignment(Ty) : 0,
254 Ty, MemRef::Read | MemRef::Write);
255 }
256 }
257 }
Dan Gohman113902e2010-04-08 18:47:09 +0000258 }
259
Dan Gohman113b3e22010-05-26 21:46:36 +0000260 if (CS.isCall() && cast<CallInst>(CS.getInstruction())->isTailCall())
261 for (CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
262 AI != AE; ++AI) {
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000263 Value *Obj = findValue(*AI, /*OffsetOk=*/true);
Dan Gohman078f8592010-05-28 16:34:49 +0000264 Assert1(!isa<AllocaInst>(Obj),
Dan Gohman113b3e22010-05-26 21:46:36 +0000265 "Undefined behavior: Call with \"tail\" keyword references "
Dan Gohman078f8592010-05-28 16:34:49 +0000266 "alloca", &I);
Dan Gohman113b3e22010-05-26 21:46:36 +0000267 }
268
Dan Gohman113902e2010-04-08 18:47:09 +0000269
270 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(&I))
271 switch (II->getIntrinsicID()) {
272 default: break;
273
274 // TODO: Check more intrinsics
275
276 case Intrinsic::memcpy: {
277 MemCpyInst *MCI = cast<MemCpyInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000278 // TODO: If the size is known, use it.
279 visitMemoryReference(I, MCI->getDest(), ~0u, MCI->getAlignment(), 0,
Dan Gohman13ec30b2010-05-28 17:44:00 +0000280 MemRef::Write);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000281 visitMemoryReference(I, MCI->getSource(), ~0u, MCI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000282 MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000283
Dan Gohmanbe02b202010-04-09 01:39:53 +0000284 // Check that the memcpy arguments don't overlap. The AliasAnalysis API
285 // isn't expressive enough for what we really want to do. Known partial
286 // overlap is not distinguished from the case where nothing is known.
Dan Gohman113902e2010-04-08 18:47:09 +0000287 unsigned Size = 0;
288 if (const ConstantInt *Len =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000289 dyn_cast<ConstantInt>(findValue(MCI->getLength(),
290 /*OffsetOk=*/false)))
Dan Gohman113902e2010-04-08 18:47:09 +0000291 if (Len->getValue().isIntN(32))
292 Size = Len->getValue().getZExtValue();
293 Assert1(AA->alias(MCI->getSource(), Size, MCI->getDest(), Size) !=
294 AliasAnalysis::MustAlias,
Dan Gohmanbe02b202010-04-09 01:39:53 +0000295 "Undefined behavior: memcpy source and destination overlap", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000296 break;
297 }
298 case Intrinsic::memmove: {
299 MemMoveInst *MMI = cast<MemMoveInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000300 // TODO: If the size is known, use it.
301 visitMemoryReference(I, MMI->getDest(), ~0u, MMI->getAlignment(), 0,
Dan Gohman13ec30b2010-05-28 17:44:00 +0000302 MemRef::Write);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000303 visitMemoryReference(I, MMI->getSource(), ~0u, MMI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000304 MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000305 break;
306 }
307 case Intrinsic::memset: {
308 MemSetInst *MSI = cast<MemSetInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000309 // TODO: If the size is known, use it.
310 visitMemoryReference(I, MSI->getDest(), ~0u, MSI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000311 MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000312 break;
313 }
314
315 case Intrinsic::vastart:
Dan Gohmanbe02b202010-04-09 01:39:53 +0000316 Assert1(I.getParent()->getParent()->isVarArg(),
317 "Undefined behavior: va_start called in a non-varargs function",
318 &I);
319
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000320 visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000321 MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000322 break;
323 case Intrinsic::vacopy:
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000324 visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0, MemRef::Write);
325 visitMemoryReference(I, CS.getArgument(1), ~0u, 0, 0, MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000326 break;
327 case Intrinsic::vaend:
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000328 visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000329 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 Gohmanaec2a0d2010-05-28 21:43:57 +0000336 visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0,
Dan Gohman882ddb42010-05-26 22:21:25 +0000337 MemRef::Read | MemRef::Write);
338 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 Gohman113902e2010-04-08 18:47:09 +0000364void Lint::visitMemoryReference(Instruction &I,
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000365 Value *Ptr, unsigned Size, unsigned Align,
366 const Type *Ty, unsigned Flags) {
367 // If no memory is being referenced, it doesn't matter if the pointer
368 // is valid.
369 if (Size == 0)
370 return;
371
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000372 Value *UnderlyingObject = findValue(Ptr, /*OffsetOk=*/true);
Dan Gohmanbe02b202010-04-09 01:39:53 +0000373 Assert1(!isa<ConstantPointerNull>(UnderlyingObject),
374 "Undefined behavior: Null pointer dereference", &I);
375 Assert1(!isa<UndefValue>(UnderlyingObject),
376 "Undefined behavior: Undef pointer dereference", &I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000377 Assert1(!isa<ConstantInt>(UnderlyingObject) ||
378 !cast<ConstantInt>(UnderlyingObject)->isAllOnesValue(),
379 "Unusual: All-ones pointer dereference", &I);
380 Assert1(!isa<ConstantInt>(UnderlyingObject) ||
381 !cast<ConstantInt>(UnderlyingObject)->isOne(),
382 "Unusual: Address one pointer dereference", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000383
Dan Gohman5b61b382010-04-30 19:05:00 +0000384 if (Flags & MemRef::Write) {
385 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(UnderlyingObject))
386 Assert1(!GV->isConstant(),
387 "Undefined behavior: Write to read-only memory", &I);
388 Assert1(!isa<Function>(UnderlyingObject) &&
389 !isa<BlockAddress>(UnderlyingObject),
390 "Undefined behavior: Write to text section", &I);
391 }
392 if (Flags & MemRef::Read) {
393 Assert1(!isa<Function>(UnderlyingObject),
394 "Unusual: Load from function body", &I);
395 Assert1(!isa<BlockAddress>(UnderlyingObject),
396 "Undefined behavior: Load from block address", &I);
397 }
398 if (Flags & MemRef::Callee) {
399 Assert1(!isa<BlockAddress>(UnderlyingObject),
400 "Undefined behavior: Call to block address", &I);
401 }
402 if (Flags & MemRef::Branchee) {
403 Assert1(!isa<Constant>(UnderlyingObject) ||
404 isa<BlockAddress>(UnderlyingObject),
405 "Undefined behavior: Branch to non-blockaddress", &I);
406 }
407
Dan Gohman113902e2010-04-08 18:47:09 +0000408 if (TD) {
409 if (Align == 0 && Ty) Align = TD->getABITypeAlignment(Ty);
410
411 if (Align != 0) {
412 unsigned BitWidth = TD->getTypeSizeInBits(Ptr->getType());
413 APInt Mask = APInt::getAllOnesValue(BitWidth),
414 KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
415 ComputeMaskedBits(Ptr, Mask, KnownZero, KnownOne, TD);
416 Assert1(!(KnownOne & APInt::getLowBitsSet(BitWidth, Log2_32(Align))),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000417 "Undefined behavior: Memory reference address is misaligned", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000418 }
419 }
420}
421
422void Lint::visitLoadInst(LoadInst &I) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000423 visitMemoryReference(I, I.getPointerOperand(),
424 AA->getTypeStoreSize(I.getType()), I.getAlignment(),
425 I.getType(), MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000426}
427
428void Lint::visitStoreInst(StoreInst &I) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000429 visitMemoryReference(I, I.getPointerOperand(),
430 AA->getTypeStoreSize(I.getOperand(0)->getType()),
431 I.getAlignment(),
432 I.getOperand(0)->getType(), MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000433}
434
Dan Gohmanbe02b202010-04-09 01:39:53 +0000435void Lint::visitXor(BinaryOperator &I) {
436 Assert1(!isa<UndefValue>(I.getOperand(0)) ||
437 !isa<UndefValue>(I.getOperand(1)),
438 "Undefined result: xor(undef, undef)", &I);
439}
440
441void Lint::visitSub(BinaryOperator &I) {
442 Assert1(!isa<UndefValue>(I.getOperand(0)) ||
443 !isa<UndefValue>(I.getOperand(1)),
444 "Undefined result: sub(undef, undef)", &I);
445}
446
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000447void Lint::visitLShr(BinaryOperator &I) {
448 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000449 dyn_cast<ConstantInt>(findValue(I.getOperand(1), /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000450 Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000451 "Undefined result: Shift count out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000452}
453
454void Lint::visitAShr(BinaryOperator &I) {
455 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000456 dyn_cast<ConstantInt>(findValue(I.getOperand(1), /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000457 Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000458 "Undefined result: Shift count out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000459}
460
461void Lint::visitShl(BinaryOperator &I) {
462 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000463 dyn_cast<ConstantInt>(findValue(I.getOperand(1), /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000464 Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000465 "Undefined result: Shift count out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000466}
467
Dan Gohman113902e2010-04-08 18:47:09 +0000468static bool isZero(Value *V, TargetData *TD) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000469 // Assume undef could be zero.
470 if (isa<UndefValue>(V)) return true;
471
Dan Gohman113902e2010-04-08 18:47:09 +0000472 unsigned BitWidth = cast<IntegerType>(V->getType())->getBitWidth();
473 APInt Mask = APInt::getAllOnesValue(BitWidth),
474 KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
475 ComputeMaskedBits(V, Mask, KnownZero, KnownOne, TD);
476 return KnownZero.isAllOnesValue();
477}
478
479void Lint::visitSDiv(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000480 Assert1(!isZero(I.getOperand(1), TD),
481 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000482}
483
484void Lint::visitUDiv(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000485 Assert1(!isZero(I.getOperand(1), TD),
486 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000487}
488
489void Lint::visitSRem(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000490 Assert1(!isZero(I.getOperand(1), TD),
491 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000492}
493
494void Lint::visitURem(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000495 Assert1(!isZero(I.getOperand(1), TD),
496 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000497}
498
499void Lint::visitAllocaInst(AllocaInst &I) {
500 if (isa<ConstantInt>(I.getArraySize()))
501 // This isn't undefined behavior, it's just an obvious pessimization.
502 Assert1(&I.getParent()->getParent()->getEntryBlock() == I.getParent(),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000503 "Pessimization: Static alloca outside of entry block", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000504}
505
506void Lint::visitVAArgInst(VAArgInst &I) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000507 visitMemoryReference(I, I.getOperand(0), ~0u, 0, 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000508 MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000509}
510
511void Lint::visitIndirectBrInst(IndirectBrInst &I) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000512 visitMemoryReference(I, I.getAddress(), ~0u, 0, 0, MemRef::Branchee);
Dan Gohman113902e2010-04-08 18:47:09 +0000513}
514
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000515void Lint::visitExtractElementInst(ExtractElementInst &I) {
516 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000517 dyn_cast<ConstantInt>(findValue(I.getIndexOperand(),
518 /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000519 Assert1(CI->getValue().ult(I.getVectorOperandType()->getNumElements()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000520 "Undefined result: extractelement index out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000521}
522
523void Lint::visitInsertElementInst(InsertElementInst &I) {
524 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000525 dyn_cast<ConstantInt>(findValue(I.getOperand(2),
526 /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000527 Assert1(CI->getValue().ult(I.getType()->getNumElements()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000528 "Undefined result: insertelement index out of range", &I);
529}
530
531void Lint::visitUnreachableInst(UnreachableInst &I) {
532 // This isn't undefined behavior, it's merely suspicious.
533 Assert1(&I == I.getParent()->begin() ||
534 prior(BasicBlock::iterator(&I))->mayHaveSideEffects(),
535 "Unusual: unreachable immediately preceded by instruction without "
536 "side effects", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000537}
538
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000539/// findValue - Look through bitcasts and simple memory reference patterns
540/// to identify an equivalent, but more informative, value. If OffsetOk
541/// is true, look through getelementptrs with non-zero offsets too.
542///
543/// Most analysis passes don't require this logic, because instcombine
544/// will simplify most of these kinds of things away. But it's a goal of
545/// this Lint pass to be useful even on non-optimized IR.
546Value *Lint::findValue(Value *V, bool OffsetOk) const {
Dan Gohman17d95962010-05-28 16:45:33 +0000547 SmallPtrSet<Value *, 4> Visited;
548 return findValueImpl(V, OffsetOk, Visited);
549}
550
551/// findValueImpl - Implementation helper for findValue.
552Value *Lint::findValueImpl(Value *V, bool OffsetOk,
553 SmallPtrSet<Value *, 4> &Visited) const {
554 // Detect self-referential values.
555 if (!Visited.insert(V))
556 return UndefValue::get(V->getType());
557
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000558 // TODO: Look through sext or zext cast, when the result is known to
559 // be interpreted as signed or unsigned, respectively.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000560 // TODO: Look through eliminable cast pairs.
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000561 // TODO: Look through calls with unique return values.
562 // TODO: Look through vector insert/extract/shuffle.
563 V = OffsetOk ? V->getUnderlyingObject() : V->stripPointerCasts();
564 if (LoadInst *L = dyn_cast<LoadInst>(V)) {
565 BasicBlock::iterator BBI = L;
566 BasicBlock *BB = L->getParent();
Dan Gohman13ec30b2010-05-28 17:44:00 +0000567 SmallPtrSet<BasicBlock *, 4> VisitedBlocks;
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000568 for (;;) {
Dan Gohman13ec30b2010-05-28 17:44:00 +0000569 if (!VisitedBlocks.insert(BB)) break;
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000570 if (Value *U = FindAvailableLoadedValue(L->getPointerOperand(),
571 BB, BBI, 6, AA))
Dan Gohman17d95962010-05-28 16:45:33 +0000572 return findValueImpl(U, OffsetOk, Visited);
Dan Gohman13ec30b2010-05-28 17:44:00 +0000573 if (BBI != BB->begin()) break;
574 BB = BB->getUniquePredecessor();
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000575 if (!BB) break;
576 BBI = BB->end();
577 }
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000578 } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
579 if (Value *W = PN->hasConstantValue(DT))
580 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000581 } else if (CastInst *CI = dyn_cast<CastInst>(V)) {
582 if (CI->isNoopCast(TD ? TD->getIntPtrType(V->getContext()) :
583 Type::getInt64Ty(V->getContext())))
Dan Gohman17d95962010-05-28 16:45:33 +0000584 return findValueImpl(CI->getOperand(0), OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000585 } else if (ExtractValueInst *Ex = dyn_cast<ExtractValueInst>(V)) {
586 if (Value *W = FindInsertedValue(Ex->getAggregateOperand(),
587 Ex->idx_begin(),
588 Ex->idx_end()))
589 if (W != V)
Dan Gohman17d95962010-05-28 16:45:33 +0000590 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000591 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
592 // Same as above, but for ConstantExpr instead of Instruction.
593 if (Instruction::isCast(CE->getOpcode())) {
594 if (CastInst::isNoopCast(Instruction::CastOps(CE->getOpcode()),
595 CE->getOperand(0)->getType(),
596 CE->getType(),
597 TD ? TD->getIntPtrType(V->getContext()) :
598 Type::getInt64Ty(V->getContext())))
599 return findValueImpl(CE->getOperand(0), OffsetOk, Visited);
600 } else if (CE->getOpcode() == Instruction::ExtractValue) {
601 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
602 if (Value *W = FindInsertedValue(CE->getOperand(0),
603 Indices.begin(),
604 Indices.end()))
605 if (W != V)
606 return findValueImpl(W, OffsetOk, Visited);
607 }
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000608 }
609
610 // As a last resort, try SimplifyInstruction or constant folding.
611 if (Instruction *Inst = dyn_cast<Instruction>(V)) {
612 if (Value *W = SimplifyInstruction(Inst, TD))
613 if (W != Inst)
Dan Gohman17d95962010-05-28 16:45:33 +0000614 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000615 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
616 if (Value *W = ConstantFoldConstantExpression(CE, TD))
617 if (W != V)
Dan Gohman17d95962010-05-28 16:45:33 +0000618 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000619 }
620
621 return V;
622}
623
Dan Gohman113902e2010-04-08 18:47:09 +0000624//===----------------------------------------------------------------------===//
625// Implement the public interfaces to this file...
626//===----------------------------------------------------------------------===//
627
628FunctionPass *llvm::createLintPass() {
629 return new Lint();
630}
631
632/// lintFunction - Check a function for errors, printing messages on stderr.
633///
634void llvm::lintFunction(const Function &f) {
635 Function &F = const_cast<Function&>(f);
636 assert(!F.isDeclaration() && "Cannot lint external functions");
637
638 FunctionPassManager FPM(F.getParent());
639 Lint *V = new Lint();
640 FPM.add(V);
641 FPM.run(F);
642}
643
644/// lintModule - Check a module for errors, printing messages on stderr.
Dan Gohman113902e2010-04-08 18:47:09 +0000645///
Dan Gohmana0f7ff32010-05-26 22:28:53 +0000646void llvm::lintModule(const Module &M) {
Dan Gohman113902e2010-04-08 18:47:09 +0000647 PassManager PM;
648 Lint *V = new Lint();
649 PM.add(V);
650 PM.run(const_cast<Module&>(M));
Dan Gohman113902e2010-04-08 18:47:09 +0000651}