blob: 8b76b873374e2054bb5a278db3e45b6538fbfdd3 [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,
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
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
204 const FunctionType *FT = F->getFunctionType();
205 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
229 // Check that noalias arguments don't alias other arguments. The
230 // AliasAnalysis API isn't expressive enough for what we really want
231 // to do. Known partial overlap is not distinguished from the case
232 // where nothing is known.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000233 if (Formal->hasNoAliasAttr() && Actual->getType()->isPointerTy())
Dan Gohmanf3b8c762010-11-11 19:23:51 +0000234 for (CallSite::arg_iterator BI = CS.arg_begin(); BI != AE; ++BI)
235 Assert1(AI == BI ||
236 !(*BI)->getType()->isPointerTy() ||
237 AA->alias(*AI, *BI) != AliasAnalysis::MustAlias,
Dan Gohman10e77262010-06-01 20:51:40 +0000238 "Unusual: noalias argument aliases another argument", &I);
Dan Gohman10e77262010-06-01 20:51:40 +0000239
240 // Check that an sret argument points to valid memory.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000241 if (Formal->hasStructRetAttr() && Actual->getType()->isPointerTy()) {
242 const Type *Ty =
243 cast<PointerType>(Formal->getType())->getElementType();
244 visitMemoryReference(I, Actual, AA->getTypeStoreSize(Ty),
245 TD ? TD->getABITypeAlignment(Ty) : 0,
246 Ty, MemRef::Read | MemRef::Write);
247 }
248 }
249 }
Dan Gohman113902e2010-04-08 18:47:09 +0000250 }
251
Dan Gohman113b3e22010-05-26 21:46:36 +0000252 if (CS.isCall() && cast<CallInst>(CS.getInstruction())->isTailCall())
253 for (CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
254 AI != AE; ++AI) {
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000255 Value *Obj = findValue(*AI, /*OffsetOk=*/true);
Dan Gohman078f8592010-05-28 16:34:49 +0000256 Assert1(!isa<AllocaInst>(Obj),
Dan Gohman113b3e22010-05-26 21:46:36 +0000257 "Undefined behavior: Call with \"tail\" keyword references "
Dan Gohman078f8592010-05-28 16:34:49 +0000258 "alloca", &I);
Dan Gohman113b3e22010-05-26 21:46:36 +0000259 }
260
Dan Gohman113902e2010-04-08 18:47:09 +0000261
262 if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(&I))
263 switch (II->getIntrinsicID()) {
264 default: break;
265
266 // TODO: Check more intrinsics
267
268 case Intrinsic::memcpy: {
269 MemCpyInst *MCI = cast<MemCpyInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000270 // TODO: If the size is known, use it.
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000271 visitMemoryReference(I, MCI->getDest(), AliasAnalysis::UnknownSize,
272 MCI->getAlignment(), 0,
Dan Gohman13ec30b2010-05-28 17:44:00 +0000273 MemRef::Write);
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000274 visitMemoryReference(I, MCI->getSource(), AliasAnalysis::UnknownSize,
275 MCI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000276 MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000277
Dan Gohmanbe02b202010-04-09 01:39:53 +0000278 // Check that the memcpy arguments don't overlap. The AliasAnalysis API
279 // isn't expressive enough for what we really want to do. Known partial
280 // overlap is not distinguished from the case where nothing is known.
Dan Gohman3da848b2010-10-19 22:54:46 +0000281 uint64_t Size = 0;
Dan Gohman113902e2010-04-08 18:47:09 +0000282 if (const ConstantInt *Len =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000283 dyn_cast<ConstantInt>(findValue(MCI->getLength(),
284 /*OffsetOk=*/false)))
Dan Gohman113902e2010-04-08 18:47:09 +0000285 if (Len->getValue().isIntN(32))
286 Size = Len->getValue().getZExtValue();
287 Assert1(AA->alias(MCI->getSource(), Size, MCI->getDest(), Size) !=
288 AliasAnalysis::MustAlias,
Dan Gohmanbe02b202010-04-09 01:39:53 +0000289 "Undefined behavior: memcpy source and destination overlap", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000290 break;
291 }
292 case Intrinsic::memmove: {
293 MemMoveInst *MMI = cast<MemMoveInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000294 // TODO: If the size is known, use it.
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000295 visitMemoryReference(I, MMI->getDest(), AliasAnalysis::UnknownSize,
296 MMI->getAlignment(), 0,
Dan Gohman13ec30b2010-05-28 17:44:00 +0000297 MemRef::Write);
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000298 visitMemoryReference(I, MMI->getSource(), AliasAnalysis::UnknownSize,
299 MMI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000300 MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000301 break;
302 }
303 case Intrinsic::memset: {
304 MemSetInst *MSI = cast<MemSetInst>(&I);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000305 // TODO: If the size is known, use it.
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000306 visitMemoryReference(I, MSI->getDest(), AliasAnalysis::UnknownSize,
307 MSI->getAlignment(), 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000308 MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000309 break;
310 }
311
312 case Intrinsic::vastart:
Dan Gohmanbe02b202010-04-09 01:39:53 +0000313 Assert1(I.getParent()->getParent()->isVarArg(),
314 "Undefined behavior: va_start called in a non-varargs function",
315 &I);
316
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000317 visitMemoryReference(I, CS.getArgument(0), AliasAnalysis::UnknownSize,
318 0, 0, MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000319 break;
320 case Intrinsic::vacopy:
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000321 visitMemoryReference(I, CS.getArgument(0), AliasAnalysis::UnknownSize,
322 0, 0, MemRef::Write);
323 visitMemoryReference(I, CS.getArgument(1), AliasAnalysis::UnknownSize,
324 0, 0, MemRef::Read);
Dan Gohman113902e2010-04-08 18:47:09 +0000325 break;
326 case Intrinsic::vaend:
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000327 visitMemoryReference(I, CS.getArgument(0), AliasAnalysis::UnknownSize,
328 0, 0, MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000329 break;
Dan Gohman882ddb42010-05-26 22:21:25 +0000330
331 case Intrinsic::stackrestore:
332 // Stackrestore doesn't read or write memory, but it sets the
333 // stack pointer, which the compiler may read from or write to
334 // at any time, so check it for both readability and writeability.
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000335 visitMemoryReference(I, CS.getArgument(0), AliasAnalysis::UnknownSize,
336 0, 0, MemRef::Read | MemRef::Write);
Dan Gohman882ddb42010-05-26 22:21:25 +0000337 break;
Dan Gohman113902e2010-04-08 18:47:09 +0000338 }
339}
340
341void Lint::visitCallInst(CallInst &I) {
342 return visitCallSite(&I);
343}
344
345void Lint::visitInvokeInst(InvokeInst &I) {
346 return visitCallSite(&I);
347}
348
349void Lint::visitReturnInst(ReturnInst &I) {
350 Function *F = I.getParent()->getParent();
351 Assert1(!F->doesNotReturn(),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000352 "Unusual: Return statement in function with noreturn attribute",
353 &I);
Dan Gohman292fc872010-05-28 04:33:42 +0000354
355 if (Value *V = I.getReturnValue()) {
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000356 Value *Obj = findValue(V, /*OffsetOk=*/true);
Dan Gohman078f8592010-05-28 16:34:49 +0000357 Assert1(!isa<AllocaInst>(Obj),
358 "Unusual: Returning alloca value", &I);
Dan Gohman292fc872010-05-28 04:33:42 +0000359 }
Dan Gohman113902e2010-04-08 18:47:09 +0000360}
361
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000362// TODO: Check that the reference is in bounds.
Dan Gohman0ce24992010-07-06 15:23:00 +0000363// TODO: Check readnone/readonly function attributes.
Dan Gohman113902e2010-04-08 18:47:09 +0000364void Lint::visitMemoryReference(Instruction &I,
Dan Gohman3da848b2010-10-19 22:54:46 +0000365 Value *Ptr, uint64_t Size, unsigned Align,
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000366 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 Gohman0ce24992010-07-06 15:23:00 +0000504
505 // TODO: Check for an unusual size (MSB set?)
Dan Gohman113902e2010-04-08 18:47:09 +0000506}
507
508void Lint::visitVAArgInst(VAArgInst &I) {
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000509 visitMemoryReference(I, I.getOperand(0), AliasAnalysis::UnknownSize, 0, 0,
Dan Gohman5b61b382010-04-30 19:05:00 +0000510 MemRef::Read | MemRef::Write);
Dan Gohman113902e2010-04-08 18:47:09 +0000511}
512
513void Lint::visitIndirectBrInst(IndirectBrInst &I) {
Dan Gohmanf3a925d2010-10-19 17:06:23 +0000514 visitMemoryReference(I, I.getAddress(), AliasAnalysis::UnknownSize, 0, 0,
515 MemRef::Branchee);
Dan Gohmana8afb2a2010-08-02 23:06:43 +0000516
517 Assert1(I.getNumDestinations() != 0,
518 "Undefined behavior: indirectbr with no destinations", &I);
Dan Gohman113902e2010-04-08 18:47:09 +0000519}
520
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000521void Lint::visitExtractElementInst(ExtractElementInst &I) {
522 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000523 dyn_cast<ConstantInt>(findValue(I.getIndexOperand(),
524 /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000525 Assert1(CI->getValue().ult(I.getVectorOperandType()->getNumElements()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000526 "Undefined result: extractelement index out of range", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000527}
528
529void Lint::visitInsertElementInst(InsertElementInst &I) {
530 if (ConstantInt *CI =
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000531 dyn_cast<ConstantInt>(findValue(I.getOperand(2),
532 /*OffsetOk=*/false)))
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000533 Assert1(CI->getValue().ult(I.getType()->getNumElements()),
Dan Gohmanbe02b202010-04-09 01:39:53 +0000534 "Undefined result: insertelement index out of range", &I);
535}
536
537void Lint::visitUnreachableInst(UnreachableInst &I) {
538 // This isn't undefined behavior, it's merely suspicious.
539 Assert1(&I == I.getParent()->begin() ||
540 prior(BasicBlock::iterator(&I))->mayHaveSideEffects(),
541 "Unusual: unreachable immediately preceded by instruction without "
542 "side effects", &I);
Dan Gohmandd98c4d2010-04-08 23:05:57 +0000543}
544
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000545/// findValue - Look through bitcasts and simple memory reference patterns
546/// to identify an equivalent, but more informative, value. If OffsetOk
547/// is true, look through getelementptrs with non-zero offsets too.
548///
549/// Most analysis passes don't require this logic, because instcombine
550/// will simplify most of these kinds of things away. But it's a goal of
551/// this Lint pass to be useful even on non-optimized IR.
552Value *Lint::findValue(Value *V, bool OffsetOk) const {
Dan Gohman17d95962010-05-28 16:45:33 +0000553 SmallPtrSet<Value *, 4> Visited;
554 return findValueImpl(V, OffsetOk, Visited);
555}
556
557/// findValueImpl - Implementation helper for findValue.
558Value *Lint::findValueImpl(Value *V, bool OffsetOk,
559 SmallPtrSet<Value *, 4> &Visited) const {
560 // Detect self-referential values.
561 if (!Visited.insert(V))
562 return UndefValue::get(V->getType());
563
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000564 // TODO: Look through sext or zext cast, when the result is known to
565 // be interpreted as signed or unsigned, respectively.
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000566 // TODO: Look through eliminable cast pairs.
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000567 // TODO: Look through calls with unique return values.
568 // TODO: Look through vector insert/extract/shuffle.
569 V = OffsetOk ? V->getUnderlyingObject() : V->stripPointerCasts();
570 if (LoadInst *L = dyn_cast<LoadInst>(V)) {
571 BasicBlock::iterator BBI = L;
572 BasicBlock *BB = L->getParent();
Dan Gohman13ec30b2010-05-28 17:44:00 +0000573 SmallPtrSet<BasicBlock *, 4> VisitedBlocks;
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000574 for (;;) {
Dan Gohman13ec30b2010-05-28 17:44:00 +0000575 if (!VisitedBlocks.insert(BB)) break;
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000576 if (Value *U = FindAvailableLoadedValue(L->getPointerOperand(),
577 BB, BBI, 6, AA))
Dan Gohman17d95962010-05-28 16:45:33 +0000578 return findValueImpl(U, OffsetOk, Visited);
Dan Gohman13ec30b2010-05-28 17:44:00 +0000579 if (BBI != BB->begin()) break;
580 BB = BB->getUniquePredecessor();
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000581 if (!BB) break;
582 BBI = BB->end();
583 }
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000584 } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
Duncan Sandsff103412010-11-17 04:30:22 +0000585 if (Value *W = PN->hasConstantValue())
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000586 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000587 } else if (CastInst *CI = dyn_cast<CastInst>(V)) {
588 if (CI->isNoopCast(TD ? TD->getIntPtrType(V->getContext()) :
589 Type::getInt64Ty(V->getContext())))
Dan Gohman17d95962010-05-28 16:45:33 +0000590 return findValueImpl(CI->getOperand(0), OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000591 } else if (ExtractValueInst *Ex = dyn_cast<ExtractValueInst>(V)) {
592 if (Value *W = FindInsertedValue(Ex->getAggregateOperand(),
593 Ex->idx_begin(),
594 Ex->idx_end()))
595 if (W != V)
Dan Gohman17d95962010-05-28 16:45:33 +0000596 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanaec2a0d2010-05-28 21:43:57 +0000597 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
598 // Same as above, but for ConstantExpr instead of Instruction.
599 if (Instruction::isCast(CE->getOpcode())) {
600 if (CastInst::isNoopCast(Instruction::CastOps(CE->getOpcode()),
601 CE->getOperand(0)->getType(),
602 CE->getType(),
603 TD ? TD->getIntPtrType(V->getContext()) :
604 Type::getInt64Ty(V->getContext())))
605 return findValueImpl(CE->getOperand(0), OffsetOk, Visited);
606 } else if (CE->getOpcode() == Instruction::ExtractValue) {
607 const SmallVector<unsigned, 4> &Indices = CE->getIndices();
608 if (Value *W = FindInsertedValue(CE->getOperand(0),
609 Indices.begin(),
610 Indices.end()))
611 if (W != V)
612 return findValueImpl(W, OffsetOk, Visited);
613 }
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000614 }
615
616 // As a last resort, try SimplifyInstruction or constant folding.
617 if (Instruction *Inst = dyn_cast<Instruction>(V)) {
Duncan Sandsff103412010-11-17 04:30:22 +0000618 if (Value *W = SimplifyInstruction(Inst, TD, DT))
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000619 if (W != Inst)
Dan Gohman17d95962010-05-28 16:45:33 +0000620 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000621 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
622 if (Value *W = ConstantFoldConstantExpression(CE, TD))
623 if (W != V)
Dan Gohman17d95962010-05-28 16:45:33 +0000624 return findValueImpl(W, OffsetOk, Visited);
Dan Gohmanff26d4e2010-05-28 16:21:24 +0000625 }
626
627 return V;
628}
629
Dan Gohman113902e2010-04-08 18:47:09 +0000630//===----------------------------------------------------------------------===//
631// Implement the public interfaces to this file...
632//===----------------------------------------------------------------------===//
633
634FunctionPass *llvm::createLintPass() {
635 return new Lint();
636}
637
638/// lintFunction - Check a function for errors, printing messages on stderr.
639///
640void llvm::lintFunction(const Function &f) {
641 Function &F = const_cast<Function&>(f);
642 assert(!F.isDeclaration() && "Cannot lint external functions");
643
644 FunctionPassManager FPM(F.getParent());
645 Lint *V = new Lint();
646 FPM.add(V);
647 FPM.run(F);
648}
649
650/// lintModule - Check a module for errors, printing messages on stderr.
Dan Gohman113902e2010-04-08 18:47:09 +0000651///
Dan Gohmana0f7ff32010-05-26 22:28:53 +0000652void llvm::lintModule(const Module &M) {
Dan Gohman113902e2010-04-08 18:47:09 +0000653 PassManager PM;
654 Lint *V = new Lint();
655 PM.add(V);
656 PM.run(const_cast<Module&>(M));
Dan Gohman113902e2010-04-08 18:47:09 +0000657}