blob: 9f1b30d2cf45ccd8758f05771a22236f347f9de5 [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 Gohman0ce24992010-07-06 15:23:00 +0000204
205 // TODO: Check for irreducible control flow.
Dan Gohman113902e2010-04-08 18:47:09 +0000206}
207
208void Lint::visitCallSite(CallSite CS) {
209 Instruction &I = *CS.getInstruction();
210 Value *Callee = CS.getCalledValue();
211
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000212 visitMemoryReference(I, Callee, ~0u, 0, 0, MemRef::Callee);
Dan Gohman113902e2010-04-08 18:47:09 +0000213
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000214 if (Function *F = dyn_cast<Function>(findValue(Callee, /*OffsetOk=*/false))) {
Dan Gohman113902e2010-04-08 18:47:09 +0000215 Assert1(CS.getCallingConv() == F->getCallingConv(),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000216 "Undefined behavior: Caller and callee calling convention differ",
217 &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000218
219 const FunctionType *FT = F->getFunctionType();
220 unsigned NumActualArgs = unsigned(CS.arg_end()-CS.arg_begin());
221
222 Assert1(FT->isVarArg() ?
223 FT->getNumParams() <= NumActualArgs :
224 FT->getNumParams() == NumActualArgs,
Dan Gohmanbe02b202010-04-09 01:39:53 +0000225 "Undefined behavior: Call argument count mismatches callee "
226 "argument count", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000227
Dan Gohman545d0062010-07-12 18:02:04 +0000228 Assert1(FT->getReturnType() == I.getType(),
229 "Undefined behavior: Call return type mismatches "
230 "callee return type", &I);
231
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000232 // Check argument types (in case the callee was casted) and attributes.
Dan Gohman0ce24992010-07-06 15:23:00 +0000233 // TODO: Verify that caller and callee attributes are compatible.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000234 Function::arg_iterator PI = F->arg_begin(), PE = F->arg_end();
235 CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
236 for (; AI != AE; ++AI) {
237 Value *Actual = *AI;
238 if (PI != PE) {
239 Argument *Formal = PI++;
240 Assert1(Formal->getType() == Actual->getType(),
241 "Undefined behavior: Call argument type mismatches "
242 "callee parameter type", &I);
Dan Gohman10e77262010-06-01 20:51:40 +0000243
244 // Check that noalias arguments don't alias other arguments. The
245 // AliasAnalysis API isn't expressive enough for what we really want
246 // to do. Known partial overlap is not distinguished from the case
247 // where nothing is known.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000248 if (Formal->hasNoAliasAttr() && Actual->getType()->isPointerTy())
Dan Gohman10e77262010-06-01 20:51:40 +0000249 for (CallSite::arg_iterator BI = CS.arg_begin(); BI != AE; ++BI) {
250 Assert1(AI == BI ||
251 AA->alias(*AI, ~0u, *BI, ~0u) != AliasAnalysis::MustAlias,
252 "Unusual: noalias argument aliases another argument", &I);
253 }
254
255 // Check that an sret argument points to valid memory.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000256 if (Formal->hasStructRetAttr() && Actual->getType()->isPointerTy()) {
257 const Type *Ty =
258 cast<PointerType>(Formal->getType())->getElementType();
259 visitMemoryReference(I, Actual, AA->getTypeStoreSize(Ty),
260 TD ? TD->getABITypeAlignment(Ty) : 0,
261 Ty, MemRef::Read | MemRef::Write);
262 }
263 }
264 }
Dan Gohman113902e2010-04-08 18:47:09 +0000265 }
266
Dan Gohman113b3e22010-05-26 21:46:36 +0000267 if (CS.isCall() && cast<CallInst>(CS.getInstruction())->isTailCall())
268 for (CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
269 AI != AE; ++AI) {
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000270 Value *Obj = findValue(*AI, /*OffsetOk=*/true);
Dan Gohman078f8592010-05-28 16:34:49 +0000271 Assert1(!isa<AllocaInst>(Obj),
Dan Gohman113b3e22010-05-26 21:46:36 +0000272 "Undefined behavior: Call with \"tail\" keyword references "
Dan Gohman078f8592010-05-28 16:34:49 +0000273 "alloca", &I);
Dan Gohman113b3e22010-05-26 21:46:36 +0000274 }
275
Dan Gohman113902e2010-04-08 18:47:09 +0000276
277 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(&I))
278 switch (II->getIntrinsicID()) {
279 default: break;
280
281 // TODO: Check more intrinsics
282
283 case Intrinsic::memcpy: {
284 MemCpyInst *MCI = cast<MemCpyInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000285 // TODO: If the size is known, use it.
286 visitMemoryReference(I, MCI->getDest(), ~0u, MCI->getAlignment(), 0,
Dan Gohman13ec30b2010-05-28 17:44:00 +0000287 MemRef::Write);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000288 visitMemoryReference(I, MCI->getSource(), ~0u, MCI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000289 MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000290
Dan Gohmanbe02b202010-04-09 01:39:53 +0000291 // Check that the memcpy arguments don't overlap. The AliasAnalysis API
292 // isn't expressive enough for what we really want to do. Known partial
293 // overlap is not distinguished from the case where nothing is known.
Dan Gohman113902e2010-04-08 18:47:09 +0000294 unsigned Size = 0;
295 if (const ConstantInt *Len =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000296 dyn_cast<ConstantInt>(findValue(MCI->getLength(),
297 /*OffsetOk=*/false)))
Dan Gohman113902e2010-04-08 18:47:09 +0000298 if (Len->getValue().isIntN(32))
299 Size = Len->getValue().getZExtValue();
300 Assert1(AA->alias(MCI->getSource(), Size, MCI->getDest(), Size) !=
301 AliasAnalysis::MustAlias,
Dan Gohmanbe02b202010-04-09 01:39:53 +0000302 "Undefined behavior: memcpy source and destination overlap", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000303 break;
304 }
305 case Intrinsic::memmove: {
306 MemMoveInst *MMI = cast<MemMoveInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000307 // TODO: If the size is known, use it.
308 visitMemoryReference(I, MMI->getDest(), ~0u, MMI->getAlignment(), 0,
Dan Gohman13ec30b2010-05-28 17:44:00 +0000309 MemRef::Write);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000310 visitMemoryReference(I, MMI->getSource(), ~0u, MMI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000311 MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000312 break;
313 }
314 case Intrinsic::memset: {
315 MemSetInst *MSI = cast<MemSetInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000316 // TODO: If the size is known, use it.
317 visitMemoryReference(I, MSI->getDest(), ~0u, MSI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000318 MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000319 break;
320 }
321
322 case Intrinsic::vastart:
Dan Gohmanbe02b202010-04-09 01:39:53 +0000323 Assert1(I.getParent()->getParent()->isVarArg(),
324 "Undefined behavior: va_start called in a non-varargs function",
325 &I);
326
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000327 visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000328 MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000329 break;
330 case Intrinsic::vacopy:
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000331 visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0, MemRef::Write);
332 visitMemoryReference(I, CS.getArgument(1), ~0u, 0, 0, MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000333 break;
334 case Intrinsic::vaend:
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000335 visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000336 MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000337 break;
Dan Gohman882ddb42010-05-26 22:21:25 +0000338
339 case Intrinsic::stackrestore:
340 // Stackrestore doesn't read or write memory, but it sets the
341 // stack pointer, which the compiler may read from or write to
342 // at any time, so check it for both readability and writeability.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000343 visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0,
Dan Gohman882ddb42010-05-26 22:21:25 +0000344 MemRef::Read | MemRef::Write);
345 break;
Dan Gohman113902e2010-04-08 18:47:09 +0000346 }
347}
348
349void Lint::visitCallInst(CallInst &I) {
350 return visitCallSite(&I);
351}
352
353void Lint::visitInvokeInst(InvokeInst &I) {
354 return visitCallSite(&I);
355}
356
357void Lint::visitReturnInst(ReturnInst &I) {
358 Function *F = I.getParent()->getParent();
359 Assert1(!F->doesNotReturn(),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000360 "Unusual: Return statement in function with noreturn attribute",
361 &I);
Dan Gohman292fc872010-05-28 04:33:42 +0000362
363 if (Value *V = I.getReturnValue()) {
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000364 Value *Obj = findValue(V, /*OffsetOk=*/true);
Dan Gohman078f8592010-05-28 16:34:49 +0000365 Assert1(!isa<AllocaInst>(Obj),
366 "Unusual: Returning alloca value", &I);
Dan Gohman292fc872010-05-28 04:33:42 +0000367 }
Dan Gohman113902e2010-04-08 18:47:09 +0000368}
369
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000370// TODO: Check that the reference is in bounds.
Dan Gohman0ce24992010-07-06 15:23:00 +0000371// TODO: Check readnone/readonly function attributes.
Dan Gohman113902e2010-04-08 18:47:09 +0000372void Lint::visitMemoryReference(Instruction &I,
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000373 Value *Ptr, unsigned Size, unsigned Align,
374 const Type *Ty, unsigned Flags) {
375 // If no memory is being referenced, it doesn't matter if the pointer
376 // is valid.
377 if (Size == 0)
378 return;
379
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000380 Value *UnderlyingObject = findValue(Ptr, /*OffsetOk=*/true);
Dan Gohmanbe02b202010-04-09 01:39:53 +0000381 Assert1(!isa<ConstantPointerNull>(UnderlyingObject),
382 "Undefined behavior: Null pointer dereference", &I);
383 Assert1(!isa<UndefValue>(UnderlyingObject),
384 "Undefined behavior: Undef pointer dereference", &I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000385 Assert1(!isa<ConstantInt>(UnderlyingObject) ||
386 !cast<ConstantInt>(UnderlyingObject)->isAllOnesValue(),
387 "Unusual: All-ones pointer dereference", &I);
388 Assert1(!isa<ConstantInt>(UnderlyingObject) ||
389 !cast<ConstantInt>(UnderlyingObject)->isOne(),
390 "Unusual: Address one pointer dereference", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000391
Dan Gohman5b61b382010-04-30 19:05:00 +0000392 if (Flags & MemRef::Write) {
393 if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(UnderlyingObject))
394 Assert1(!GV->isConstant(),
395 "Undefined behavior: Write to read-only memory", &I);
396 Assert1(!isa<Function>(UnderlyingObject) &&
397 !isa<BlockAddress>(UnderlyingObject),
398 "Undefined behavior: Write to text section", &I);
399 }
400 if (Flags & MemRef::Read) {
401 Assert1(!isa<Function>(UnderlyingObject),
402 "Unusual: Load from function body", &I);
403 Assert1(!isa<BlockAddress>(UnderlyingObject),
404 "Undefined behavior: Load from block address", &I);
405 }
406 if (Flags & MemRef::Callee) {
407 Assert1(!isa<BlockAddress>(UnderlyingObject),
408 "Undefined behavior: Call to block address", &I);
409 }
410 if (Flags & MemRef::Branchee) {
411 Assert1(!isa<Constant>(UnderlyingObject) ||
412 isa<BlockAddress>(UnderlyingObject),
413 "Undefined behavior: Branch to non-blockaddress", &I);
414 }
415
Dan Gohman113902e2010-04-08 18:47:09 +0000416 if (TD) {
417 if (Align == 0 && Ty) Align = TD->getABITypeAlignment(Ty);
418
419 if (Align != 0) {
420 unsigned BitWidth = TD->getTypeSizeInBits(Ptr->getType());
421 APInt Mask = APInt::getAllOnesValue(BitWidth),
422 KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
423 ComputeMaskedBits(Ptr, Mask, KnownZero, KnownOne, TD);
424 Assert1(!(KnownOne & APInt::getLowBitsSet(BitWidth, Log2_32(Align))),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000425 "Undefined behavior: Memory reference address is misaligned", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000426 }
427 }
428}
429
430void Lint::visitLoadInst(LoadInst &I) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000431 visitMemoryReference(I, I.getPointerOperand(),
432 AA->getTypeStoreSize(I.getType()), I.getAlignment(),
433 I.getType(), MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000434}
435
436void Lint::visitStoreInst(StoreInst &I) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000437 visitMemoryReference(I, I.getPointerOperand(),
438 AA->getTypeStoreSize(I.getOperand(0)->getType()),
439 I.getAlignment(),
440 I.getOperand(0)->getType(), MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000441}
442
Dan Gohmanbe02b202010-04-09 01:39:53 +0000443void Lint::visitXor(BinaryOperator &I) {
444 Assert1(!isa<UndefValue>(I.getOperand(0)) ||
445 !isa<UndefValue>(I.getOperand(1)),
446 "Undefined result: xor(undef, undef)", &I);
447}
448
449void Lint::visitSub(BinaryOperator &I) {
450 Assert1(!isa<UndefValue>(I.getOperand(0)) ||
451 !isa<UndefValue>(I.getOperand(1)),
452 "Undefined result: sub(undef, undef)", &I);
453}
454
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000455void Lint::visitLShr(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::visitAShr(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
469void Lint::visitShl(BinaryOperator &I) {
470 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000471 dyn_cast<ConstantInt>(findValue(I.getOperand(1), /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000472 Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000473 "Undefined result: Shift count out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000474}
475
Dan Gohman113902e2010-04-08 18:47:09 +0000476static bool isZero(Value *V, TargetData *TD) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000477 // Assume undef could be zero.
478 if (isa<UndefValue>(V)) return true;
479
Dan Gohman113902e2010-04-08 18:47:09 +0000480 unsigned BitWidth = cast<IntegerType>(V->getType())->getBitWidth();
481 APInt Mask = APInt::getAllOnesValue(BitWidth),
482 KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
483 ComputeMaskedBits(V, Mask, KnownZero, KnownOne, TD);
484 return KnownZero.isAllOnesValue();
485}
486
487void Lint::visitSDiv(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000488 Assert1(!isZero(I.getOperand(1), TD),
489 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000490}
491
492void Lint::visitUDiv(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000493 Assert1(!isZero(I.getOperand(1), TD),
494 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000495}
496
497void Lint::visitSRem(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000498 Assert1(!isZero(I.getOperand(1), TD),
499 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000500}
501
502void Lint::visitURem(BinaryOperator &I) {
Dan Gohmanbe02b202010-04-09 01:39:53 +0000503 Assert1(!isZero(I.getOperand(1), TD),
504 "Undefined behavior: Division by zero", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000505}
506
507void Lint::visitAllocaInst(AllocaInst &I) {
508 if (isa<ConstantInt>(I.getArraySize()))
509 // This isn't undefined behavior, it's just an obvious pessimization.
510 Assert1(&I.getParent()->getParent()->getEntryBlock() == I.getParent(),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000511 "Pessimization: Static alloca outside of entry block", &I);
Dan Gohman0ce24992010-07-06 15:23:00 +0000512
513 // TODO: Check for an unusual size (MSB set?)
Dan Gohman113902e2010-04-08 18:47:09 +0000514}
515
516void Lint::visitVAArgInst(VAArgInst &I) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000517 visitMemoryReference(I, I.getOperand(0), ~0u, 0, 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000518 MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000519}
520
521void Lint::visitIndirectBrInst(IndirectBrInst &I) {
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000522 visitMemoryReference(I, I.getAddress(), ~0u, 0, 0, MemRef::Branchee);
Dan Gohman113902e2010-04-08 18:47:09 +0000523}
524
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000525void Lint::visitExtractElementInst(ExtractElementInst &I) {
526 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000527 dyn_cast<ConstantInt>(findValue(I.getIndexOperand(),
528 /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000529 Assert1(CI->getValue().ult(I.getVectorOperandType()->getNumElements()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000530 "Undefined result: extractelement index out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000531}
532
533void Lint::visitInsertElementInst(InsertElementInst &I) {
534 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000535 dyn_cast<ConstantInt>(findValue(I.getOperand(2),
536 /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000537 Assert1(CI->getValue().ult(I.getType()->getNumElements()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000538 "Undefined result: insertelement index out of range", &I);
539}
540
541void Lint::visitUnreachableInst(UnreachableInst &I) {
542 // This isn't undefined behavior, it's merely suspicious.
543 Assert1(&I == I.getParent()->begin() ||
544 prior(BasicBlock::iterator(&I))->mayHaveSideEffects(),
545 "Unusual: unreachable immediately preceded by instruction without "
546 "side effects", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000547}
548
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000549/// findValue - Look through bitcasts and simple memory reference patterns
550/// to identify an equivalent, but more informative, value. If OffsetOk
551/// is true, look through getelementptrs with non-zero offsets too.
552///
553/// Most analysis passes don't require this logic, because instcombine
554/// will simplify most of these kinds of things away. But it's a goal of
555/// this Lint pass to be useful even on non-optimized IR.
556Value *Lint::findValue(Value *V, bool OffsetOk) const {
Dan Gohman17d95962010-05-28 16:45:33 +0000557 SmallPtrSet<Value *, 4> Visited;
558 return findValueImpl(V, OffsetOk, Visited);
559}
560
561/// findValueImpl - Implementation helper for findValue.
562Value *Lint::findValueImpl(Value *V, bool OffsetOk,
563 SmallPtrSet<Value *, 4> &Visited) const {
564 // Detect self-referential values.
565 if (!Visited.insert(V))
566 return UndefValue::get(V->getType());
567
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000568 // TODO: Look through sext or zext cast, when the result is known to
569 // be interpreted as signed or unsigned, respectively.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000570 // TODO: Look through eliminable cast pairs.
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000571 // TODO: Look through calls with unique return values.
572 // TODO: Look through vector insert/extract/shuffle.
573 V = OffsetOk ? V->getUnderlyingObject() : V->stripPointerCasts();
574 if (LoadInst *L = dyn_cast<LoadInst>(V)) {
575 BasicBlock::iterator BBI = L;
576 BasicBlock *BB = L->getParent();
Dan Gohman13ec30b2010-05-28 17:44:00 +0000577 SmallPtrSet<BasicBlock *, 4> VisitedBlocks;
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000578 for (;;) {
Dan Gohman13ec30b2010-05-28 17:44:00 +0000579 if (!VisitedBlocks.insert(BB)) break;
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000580 if (Value *U = FindAvailableLoadedValue(L->getPointerOperand(),
581 BB, BBI, 6, AA))
Dan Gohman17d95962010-05-28 16:45:33 +0000582 return findValueImpl(U, OffsetOk, Visited);
Dan Gohman13ec30b2010-05-28 17:44:00 +0000583 if (BBI != BB->begin()) break;
584 BB = BB->getUniquePredecessor();
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000585 if (!BB) break;
586 BBI = BB->end();
587 }
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000588 } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
589 if (Value *W = PN->hasConstantValue(DT))
590 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000591 } else if (CastInst *CI = dyn_cast<CastInst>(V)) {
592 if (CI->isNoopCast(TD ? TD->getIntPtrType(V->getContext()) :
593 Type::getInt64Ty(V->getContext())))
Dan Gohman17d95962010-05-28 16:45:33 +0000594 return findValueImpl(CI->getOperand(0), OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000595 } else if (ExtractValueInst *Ex = dyn_cast<ExtractValueInst>(V)) {
596 if (Value *W = FindInsertedValue(Ex->getAggregateOperand(),
597 Ex->idx_begin(),
598 Ex->idx_end()))
599 if (W != V)
Dan Gohman17d95962010-05-28 16:45:33 +0000600 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000601 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
602 // Same as above, but for ConstantExpr instead of Instruction.
603 if (Instruction::isCast(CE->getOpcode())) {
604 if (CastInst::isNoopCast(Instruction::CastOps(CE->getOpcode()),
605 CE->getOperand(0)->getType(),
606 CE->getType(),
607 TD ? TD->getIntPtrType(V->getContext()) :
608 Type::getInt64Ty(V->getContext())))
609 return findValueImpl(CE->getOperand(0), OffsetOk, Visited);
610 } else if (CE->getOpcode() == Instruction::ExtractValue) {
611 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
612 if (Value *W = FindInsertedValue(CE->getOperand(0),
613 Indices.begin(),
614 Indices.end()))
615 if (W != V)
616 return findValueImpl(W, OffsetOk, Visited);
617 }
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000618 }
619
620 // As a last resort, try SimplifyInstruction or constant folding.
621 if (Instruction *Inst = dyn_cast<Instruction>(V)) {
622 if (Value *W = SimplifyInstruction(Inst, TD))
623 if (W != Inst)
Dan Gohman17d95962010-05-28 16:45:33 +0000624 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000625 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
626 if (Value *W = ConstantFoldConstantExpression(CE, TD))
627 if (W != V)
Dan Gohman17d95962010-05-28 16:45:33 +0000628 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000629 }
630
631 return V;
632}
633
Dan Gohman113902e2010-04-08 18:47:09 +0000634//===----------------------------------------------------------------------===//
635// Implement the public interfaces to this file...
636//===----------------------------------------------------------------------===//
637
638FunctionPass *llvm::createLintPass() {
639 return new Lint();
640}
641
642/// lintFunction - Check a function for errors, printing messages on stderr.
643///
644void llvm::lintFunction(const Function &f) {
645 Function &F = const_cast<Function&>(f);
646 assert(!F.isDeclaration() && "Cannot lint external functions");
647
648 FunctionPassManager FPM(F.getParent());
649 Lint *V = new Lint();
650 FPM.add(V);
651 FPM.run(F);
652}
653
654/// lintModule - Check a module for errors, printing messages on stderr.
Dan Gohman113902e2010-04-08 18:47:09 +0000655///
Dan Gohmana0f7ff32010-05-26 22:28:53 +0000656void llvm::lintModule(const Module &M) {
Dan Gohman113902e2010-04-08 18:47:09 +0000657 PassManager PM;
658 Lint *V = new Lint();
659 PM.add(V);
660 PM.run(const_cast<Module&>(M));
Dan Gohman113902e2010-04-08 18:47:09 +0000661}