lib/Analysis/Lint.cpp

   1 //===-- 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,
  22 // 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.
  24 //
  25 // 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"
  39 #include "llvm/Analysis/InstructionSimplify.h"
  40 #include "llvm/Analysis/ConstantFolding.h"
  41 #include "llvm/Analysis/Dominators.h"
  42 #include "llvm/Analysis/Lint.h"
  43 #include "llvm/Analysis/Loads.h"
  44 #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"
  55 #include "llvm/ADT/STLExtras.h"
  56 using namespace llvm;
  57
  58 namespace {
  59   namespace MemRef {
  60     static unsigned Read     = 1;
  61     static unsigned Write    = 2;
  62     static unsigned Callee   = 4;
  63     static unsigned Branchee = 8;
  64   }
  65
  66   class Lint : public FunctionPass, public InstVisitor<Lint> {
  67     friend class InstVisitor<Lint>;
  68
  69     void visitFunction(Function &F);
  70
  71     void visitCallSite(CallSite CS);
  72     void visitMemoryReference(Instruction &I, Value *Ptr,
  73                               unsigned Size, unsigned Align,
  74                               const Type *Ty, unsigned Flags);
  75
  76     void visitCallInst(CallInst &I);
  77     void visitInvokeInst(InvokeInst &I);
  78     void visitReturnInst(ReturnInst &I);
  79     void visitLoadInst(LoadInst &I);
  80     void visitStoreInst(StoreInst &I);
  81     void visitXor(BinaryOperator &I);
  82     void visitSub(BinaryOperator &I);
  83     void visitLShr(BinaryOperator &I);
  84     void visitAShr(BinaryOperator &I);
  85     void visitShl(BinaryOperator &I);
  86     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);
  93     void visitExtractElementInst(ExtractElementInst &I);
  94     void visitInsertElementInst(InsertElementInst &I);
  95     void visitUnreachableInst(UnreachableInst &I);
  96
  97     Value *findValue(Value *V, bool OffsetOk) const;
  98     Value *findValueImpl(Value *V, bool OffsetOk,
  99                          SmallPtrSet<Value *, 4> &Visited) const;
 100
 101   public:
 102     Module *Mod;
 103     AliasAnalysis *AA;
 104     DominatorTree *DT;
 105     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>();
 118       AU.addRequired<DominatorTree>();
 119     }
 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     // CheckFailed - A check failed, so print out the condition and the message
 133     // that failed.  This provides a nice place to put a breakpoint if you want
 134     // to see why something is not correct.
 135     void CheckFailed(const Twine &Message,
 136                      const Value *V1 = 0, const Value *V2 = 0,
 137                      const Value *V3 = 0, const Value *V4 = 0) {
 138       MessagesStr << Message.str() << "\n";
 139       WriteValue(V1);
 140       WriteValue(V2);
 141       WriteValue(V3);
 142       WriteValue(V4);
 143     }
 144   };
 145 }
 146
 147 char Lint::ID = 0;
 148 INITIALIZE_PASS(Lint, "lint", "Statically lint-checks LLVM IR", false, true);
 149
 150 // Assert - We know that cond should be true, if not print an error message.
 151 #define Assert(C, M) \
 152     do { if (!(C)) { CheckFailed(M); return; } } while (0)
 153 #define Assert1(C, M, V1) \
 154     do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 155 #define Assert2(C, M, V1, V2) \
 156     do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 157 #define Assert3(C, M, V1, V2, V3) \
 158     do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 159 #define Assert4(C, M, V1, V2, V3, V4) \
 160     do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 161
 162 // Lint::run - This is the main Analysis entry point for a
 163 // function.
 164 //
 165 bool Lint::runOnFunction(Function &F) {
 166   Mod = F.getParent();
 167   AA = &getAnalysis<AliasAnalysis>();
 168   DT = &getAnalysis<DominatorTree>();
 169   TD = getAnalysisIfAvailable<TargetData>();
 170   visit(F);
 171   dbgs() << MessagesStr.str();
 172   Messages.clear();
 173   return false;
 174 }
 175
 176 void Lint::visitFunction(Function &F) {
 177   // This isn't undefined behavior, it's just a little unusual, and it's a
 178   // fairly common mistake to neglect to name a function.
 179   Assert1(F.hasName() || F.hasLocalLinkage(),
 180           "Unusual: Unnamed function with non-local linkage", &F);
 181
 182   // TODO: Check for irreducible control flow.
 183 }
 184
 185 void Lint::visitCallSite(CallSite CS) {
 186   Instruction &I = *CS.getInstruction();
 187   Value *Callee = CS.getCalledValue();
 188
 189   visitMemoryReference(I, Callee, ~0u, 0, 0, MemRef::Callee);
 190
 191   if (Function *F = dyn_cast<Function>(findValue(Callee, /*OffsetOk=*/false))) {
 192     Assert1(CS.getCallingConv() == F->getCallingConv(),
 193             "Undefined behavior: Caller and callee calling convention differ",
 194             &I);
 195
 196     const FunctionType *FT = F->getFunctionType();
 197     unsigned NumActualArgs = unsigned(CS.arg_end()-CS.arg_begin());
 198
 199     Assert1(FT->isVarArg() ?
 200               FT->getNumParams() <= NumActualArgs :
 201               FT->getNumParams() == NumActualArgs,
 202             "Undefined behavior: Call argument count mismatches callee "
 203             "argument count", &I);
 204
 205     Assert1(FT->getReturnType() == I.getType(),
 206             "Undefined behavior: Call return type mismatches "
 207             "callee return type", &I);
 208
 209     // Check argument types (in case the callee was casted) and attributes.
 210     // TODO: Verify that caller and callee attributes are compatible.
 211     Function::arg_iterator PI = F->arg_begin(), PE = F->arg_end();
 212     CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
 213     for (; AI != AE; ++AI) {
 214       Value *Actual = *AI;
 215       if (PI != PE) {
 216         Argument *Formal = PI++;
 217         Assert1(Formal->getType() == Actual->getType(),
 218                 "Undefined behavior: Call argument type mismatches "
 219                 "callee parameter type", &I);
 220
 221         // Check that noalias arguments don't alias other arguments. The
 222         // AliasAnalysis API isn't expressive enough for what we really want
 223         // to do. Known partial overlap is not distinguished from the case
 224         // where nothing is known.
 225         if (Formal->hasNoAliasAttr() && Actual->getType()->isPointerTy())
 226           for (CallSite::arg_iterator BI = CS.arg_begin(); BI != AE; ++BI) {
 227             Assert1(AI == BI || AA->alias(*AI, *BI) != AliasAnalysis::MustAlias,
 228                     "Unusual: noalias argument aliases another argument", &I);
 229           }
 230
 231         // Check that an sret argument points to valid memory.
 232         if (Formal->hasStructRetAttr() && Actual->getType()->isPointerTy()) {
 233           const Type *Ty =
 234             cast<PointerType>(Formal->getType())->getElementType();
 235           visitMemoryReference(I, Actual, AA->getTypeStoreSize(Ty),
 236                                TD ? TD->getABITypeAlignment(Ty) : 0,
 237                                Ty, MemRef::Read | MemRef::Write);
 238         }
 239       }
 240     }
 241   }
 242
 243   if (CS.isCall() && cast<CallInst>(CS.getInstruction())->isTailCall())
 244     for (CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
 245          AI != AE; ++AI) {
 246       Value *Obj = findValue(*AI, /*OffsetOk=*/true);
 247       Assert1(!isa<AllocaInst>(Obj),
 248               "Undefined behavior: Call with \"tail\" keyword references "
 249               "alloca", &I);
 250     }
 251
 252
 253   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(&I))
 254     switch (II->getIntrinsicID()) {
 255     default: break;
 256
 257     // TODO: Check more intrinsics
 258
 259     case Intrinsic::memcpy: {
 260       MemCpyInst *MCI = cast<MemCpyInst>(&I);
 261       // TODO: If the size is known, use it.
 262       visitMemoryReference(I, MCI->getDest(), ~0u, MCI->getAlignment(), 0,
 263                            MemRef::Write);
 264       visitMemoryReference(I, MCI->getSource(), ~0u, MCI->getAlignment(), 0,
 265                            MemRef::Read);
 266
 267       // Check that the memcpy arguments don't overlap. The AliasAnalysis API
 268       // isn't expressive enough for what we really want to do. Known partial
 269       // overlap is not distinguished from the case where nothing is known.
 270       unsigned Size = 0;
 271       if (const ConstantInt *Len =
 272             dyn_cast<ConstantInt>(findValue(MCI->getLength(),
 273                                             /*OffsetOk=*/false)))
 274         if (Len->getValue().isIntN(32))
 275           Size = Len->getValue().getZExtValue();
 276       Assert1(AA->alias(MCI->getSource(), Size, MCI->getDest(), Size) !=
 277               AliasAnalysis::MustAlias,
 278               "Undefined behavior: memcpy source and destination overlap", &I);
 279       break;
 280     }
 281     case Intrinsic::memmove: {
 282       MemMoveInst *MMI = cast<MemMoveInst>(&I);
 283       // TODO: If the size is known, use it.
 284       visitMemoryReference(I, MMI->getDest(), ~0u, MMI->getAlignment(), 0,
 285                            MemRef::Write);
 286       visitMemoryReference(I, MMI->getSource(), ~0u, MMI->getAlignment(), 0,
 287                            MemRef::Read);
 288       break;
 289     }
 290     case Intrinsic::memset: {
 291       MemSetInst *MSI = cast<MemSetInst>(&I);
 292       // TODO: If the size is known, use it.
 293       visitMemoryReference(I, MSI->getDest(), ~0u, MSI->getAlignment(), 0,
 294                            MemRef::Write);
 295       break;
 296     }
 297
 298     case Intrinsic::vastart:
 299       Assert1(I.getParent()->getParent()->isVarArg(),
 300               "Undefined behavior: va_start called in a non-varargs function",
 301               &I);
 302
 303       visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0,
 304                            MemRef::Read | MemRef::Write);
 305       break;
 306     case Intrinsic::vacopy:
 307       visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0, MemRef::Write);
 308       visitMemoryReference(I, CS.getArgument(1), ~0u, 0, 0, MemRef::Read);
 309       break;
 310     case Intrinsic::vaend:
 311       visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0,
 312                            MemRef::Read | MemRef::Write);
 313       break;
 314
 315     case Intrinsic::stackrestore:
 316       // Stackrestore doesn't read or write memory, but it sets the
 317       // stack pointer, which the compiler may read from or write to
 318       // at any time, so check it for both readability and writeability.
 319       visitMemoryReference(I, CS.getArgument(0), ~0u, 0, 0,
 320                            MemRef::Read | MemRef::Write);
 321       break;
 322     }
 323 }
 324
 325 void Lint::visitCallInst(CallInst &I) {
 326   return visitCallSite(&I);
 327 }
 328
 329 void Lint::visitInvokeInst(InvokeInst &I) {
 330   return visitCallSite(&I);
 331 }
 332
 333 void Lint::visitReturnInst(ReturnInst &I) {
 334   Function *F = I.getParent()->getParent();
 335   Assert1(!F->doesNotReturn(),
 336           "Unusual: Return statement in function with noreturn attribute",
 337           &I);
 338
 339   if (Value *V = I.getReturnValue()) {
 340     Value *Obj = findValue(V, /*OffsetOk=*/true);
 341     Assert1(!isa<AllocaInst>(Obj),
 342             "Unusual: Returning alloca value", &I);
 343   }
 344 }
 345
 346 // TODO: Check that the reference is in bounds.
 347 // TODO: Check readnone/readonly function attributes.
 348 void Lint::visitMemoryReference(Instruction &I,
 349                                 Value *Ptr, unsigned Size, unsigned Align,
 350                                 const Type *Ty, unsigned Flags) {
 351   // If no memory is being referenced, it doesn't matter if the pointer
 352   // is valid.
 353   if (Size == 0)
 354     return;
 355
 356   Value *UnderlyingObject = findValue(Ptr, /*OffsetOk=*/true);
 357   Assert1(!isa<ConstantPointerNull>(UnderlyingObject),
 358           "Undefined behavior: Null pointer dereference", &I);
 359   Assert1(!isa<UndefValue>(UnderlyingObject),
 360           "Undefined behavior: Undef pointer dereference", &I);
 361   Assert1(!isa<ConstantInt>(UnderlyingObject) ||
 362           !cast<ConstantInt>(UnderlyingObject)->isAllOnesValue(),
 363           "Unusual: All-ones pointer dereference", &I);
 364   Assert1(!isa<ConstantInt>(UnderlyingObject) ||
 365           !cast<ConstantInt>(UnderlyingObject)->isOne(),
 366           "Unusual: Address one pointer dereference", &I);
 367
 368   if (Flags & MemRef::Write) {
 369     if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(UnderlyingObject))
 370       Assert1(!GV->isConstant(),
 371               "Undefined behavior: Write to read-only memory", &I);
 372     Assert1(!isa<Function>(UnderlyingObject) &&
 373             !isa<BlockAddress>(UnderlyingObject),
 374             "Undefined behavior: Write to text section", &I);
 375   }
 376   if (Flags & MemRef::Read) {
 377     Assert1(!isa<Function>(UnderlyingObject),
 378             "Unusual: Load from function body", &I);
 379     Assert1(!isa<BlockAddress>(UnderlyingObject),
 380             "Undefined behavior: Load from block address", &I);
 381   }
 382   if (Flags & MemRef::Callee) {
 383     Assert1(!isa<BlockAddress>(UnderlyingObject),
 384             "Undefined behavior: Call to block address", &I);
 385   }
 386   if (Flags & MemRef::Branchee) {
 387     Assert1(!isa<Constant>(UnderlyingObject) ||
 388             isa<BlockAddress>(UnderlyingObject),
 389             "Undefined behavior: Branch to non-blockaddress", &I);
 390   }
 391
 392   if (TD) {
 393     if (Align == 0 && Ty) Align = TD->getABITypeAlignment(Ty);
 394
 395     if (Align != 0) {
 396       unsigned BitWidth = TD->getTypeSizeInBits(Ptr->getType());
 397       APInt Mask = APInt::getAllOnesValue(BitWidth),
 398                    KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
 399       ComputeMaskedBits(Ptr, Mask, KnownZero, KnownOne, TD);
 400       Assert1(!(KnownOne & APInt::getLowBitsSet(BitWidth, Log2_32(Align))),
 401               "Undefined behavior: Memory reference address is misaligned", &I);
 402     }
 403   }
 404 }
 405
 406 void Lint::visitLoadInst(LoadInst &I) {
 407   visitMemoryReference(I, I.getPointerOperand(),
 408                        AA->getTypeStoreSize(I.getType()), I.getAlignment(),
 409                        I.getType(), MemRef::Read);
 410 }
 411
 412 void Lint::visitStoreInst(StoreInst &I) {
 413   visitMemoryReference(I, I.getPointerOperand(),
 414                        AA->getTypeStoreSize(I.getOperand(0)->getType()),
 415                        I.getAlignment(),
 416                        I.getOperand(0)->getType(), MemRef::Write);
 417 }
 418
 419 void Lint::visitXor(BinaryOperator &I) {
 420   Assert1(!isa<UndefValue>(I.getOperand(0)) ||
 421           !isa<UndefValue>(I.getOperand(1)),
 422           "Undefined result: xor(undef, undef)", &I);
 423 }
 424
 425 void Lint::visitSub(BinaryOperator &I) {
 426   Assert1(!isa<UndefValue>(I.getOperand(0)) ||
 427           !isa<UndefValue>(I.getOperand(1)),
 428           "Undefined result: sub(undef, undef)", &I);
 429 }
 430
 431 void Lint::visitLShr(BinaryOperator &I) {
 432   if (ConstantInt *CI =
 433         dyn_cast<ConstantInt>(findValue(I.getOperand(1), /*OffsetOk=*/false)))
 434     Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
 435             "Undefined result: Shift count out of range", &I);
 436 }
 437
 438 void Lint::visitAShr(BinaryOperator &I) {
 439   if (ConstantInt *CI =
 440         dyn_cast<ConstantInt>(findValue(I.getOperand(1), /*OffsetOk=*/false)))
 441     Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
 442             "Undefined result: Shift count out of range", &I);
 443 }
 444
 445 void Lint::visitShl(BinaryOperator &I) {
 446   if (ConstantInt *CI =
 447         dyn_cast<ConstantInt>(findValue(I.getOperand(1), /*OffsetOk=*/false)))
 448     Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
 449             "Undefined result: Shift count out of range", &I);
 450 }
 451
 452 static bool isZero(Value *V, TargetData *TD) {
 453   // Assume undef could be zero.
 454   if (isa<UndefValue>(V)) return true;
 455
 456   unsigned BitWidth = cast<IntegerType>(V->getType())->getBitWidth();
 457   APInt Mask = APInt::getAllOnesValue(BitWidth),
 458                KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
 459   ComputeMaskedBits(V, Mask, KnownZero, KnownOne, TD);
 460   return KnownZero.isAllOnesValue();
 461 }
 462
 463 void Lint::visitSDiv(BinaryOperator &I) {
 464   Assert1(!isZero(I.getOperand(1), TD),
 465           "Undefined behavior: Division by zero", &I);
 466 }
 467
 468 void Lint::visitUDiv(BinaryOperator &I) {
 469   Assert1(!isZero(I.getOperand(1), TD),
 470           "Undefined behavior: Division by zero", &I);
 471 }
 472
 473 void Lint::visitSRem(BinaryOperator &I) {
 474   Assert1(!isZero(I.getOperand(1), TD),
 475           "Undefined behavior: Division by zero", &I);
 476 }
 477
 478 void Lint::visitURem(BinaryOperator &I) {
 479   Assert1(!isZero(I.getOperand(1), TD),
 480           "Undefined behavior: Division by zero", &I);
 481 }
 482
 483 void Lint::visitAllocaInst(AllocaInst &I) {
 484   if (isa<ConstantInt>(I.getArraySize()))
 485     // This isn't undefined behavior, it's just an obvious pessimization.
 486     Assert1(&I.getParent()->getParent()->getEntryBlock() == I.getParent(),
 487             "Pessimization: Static alloca outside of entry block", &I);
 488
 489   // TODO: Check for an unusual size (MSB set?)
 490 }
 491
 492 void Lint::visitVAArgInst(VAArgInst &I) {
 493   visitMemoryReference(I, I.getOperand(0), ~0u, 0, 0,
 494                        MemRef::Read | MemRef::Write);
 495 }
 496
 497 void Lint::visitIndirectBrInst(IndirectBrInst &I) {
 498   visitMemoryReference(I, I.getAddress(), ~0u, 0, 0, MemRef::Branchee);
 499
 500   Assert1(I.getNumDestinations() != 0,
 501           "Undefined behavior: indirectbr with no destinations", &I);
 502 }
 503
 504 void Lint::visitExtractElementInst(ExtractElementInst &I) {
 505   if (ConstantInt *CI =
 506         dyn_cast<ConstantInt>(findValue(I.getIndexOperand(),
 507                                         /*OffsetOk=*/false)))
 508     Assert1(CI->getValue().ult(I.getVectorOperandType()->getNumElements()),
 509             "Undefined result: extractelement index out of range", &I);
 510 }
 511
 512 void Lint::visitInsertElementInst(InsertElementInst &I) {
 513   if (ConstantInt *CI =
 514         dyn_cast<ConstantInt>(findValue(I.getOperand(2),
 515                                         /*OffsetOk=*/false)))
 516     Assert1(CI->getValue().ult(I.getType()->getNumElements()),
 517             "Undefined result: insertelement index out of range", &I);
 518 }
 519
 520 void Lint::visitUnreachableInst(UnreachableInst &I) {
 521   // This isn't undefined behavior, it's merely suspicious.
 522   Assert1(&I == I.getParent()->begin() ||
 523           prior(BasicBlock::iterator(&I))->mayHaveSideEffects(),
 524           "Unusual: unreachable immediately preceded by instruction without "
 525           "side effects", &I);
 526 }
 527
 528 /// findValue - Look through bitcasts and simple memory reference patterns
 529 /// to identify an equivalent, but more informative, value.  If OffsetOk
 530 /// is true, look through getelementptrs with non-zero offsets too.
 531 ///
 532 /// Most analysis passes don't require this logic, because instcombine
 533 /// will simplify most of these kinds of things away. But it's a goal of
 534 /// this Lint pass to be useful even on non-optimized IR.
 535 Value *Lint::findValue(Value *V, bool OffsetOk) const {
 536   SmallPtrSet<Value *, 4> Visited;
 537   return findValueImpl(V, OffsetOk, Visited);
 538 }
 539
 540 /// findValueImpl - Implementation helper for findValue.
 541 Value *Lint::findValueImpl(Value *V, bool OffsetOk,
 542                            SmallPtrSet<Value *, 4> &Visited) const {
 543   // Detect self-referential values.
 544   if (!Visited.insert(V))
 545     return UndefValue::get(V->getType());
 546
 547   // TODO: Look through sext or zext cast, when the result is known to
 548   // be interpreted as signed or unsigned, respectively.
 549   // TODO: Look through eliminable cast pairs.
 550   // TODO: Look through calls with unique return values.
 551   // TODO: Look through vector insert/extract/shuffle.
 552   V = OffsetOk ? V->getUnderlyingObject() : V->stripPointerCasts();
 553   if (LoadInst *L = dyn_cast<LoadInst>(V)) {
 554     BasicBlock::iterator BBI = L;
 555     BasicBlock *BB = L->getParent();
 556     SmallPtrSet<BasicBlock *, 4> VisitedBlocks;
 557     for (;;) {
 558       if (!VisitedBlocks.insert(BB)) break;
 559       if (Value *U = FindAvailableLoadedValue(L->getPointerOperand(),
 560                                               BB, BBI, 6, AA))
 561         return findValueImpl(U, OffsetOk, Visited);
 562       if (BBI != BB->begin()) break;
 563       BB = BB->getUniquePredecessor();
 564       if (!BB) break;
 565       BBI = BB->end();
 566     }
 567   } else if (PHINode *PN = dyn_cast<PHINode>(V)) {
 568     if (Value *W = PN->hasConstantValue(DT))
 569       return findValueImpl(W, OffsetOk, Visited);
 570   } else if (CastInst *CI = dyn_cast<CastInst>(V)) {
 571     if (CI->isNoopCast(TD ? TD->getIntPtrType(V->getContext()) :
 572                             Type::getInt64Ty(V->getContext())))
 573       return findValueImpl(CI->getOperand(0), OffsetOk, Visited);
 574   } else if (ExtractValueInst *Ex = dyn_cast<ExtractValueInst>(V)) {
 575     if (Value *W = FindInsertedValue(Ex->getAggregateOperand(),
 576                                      Ex->idx_begin(),
 577                                      Ex->idx_end()))
 578       if (W != V)
 579         return findValueImpl(W, OffsetOk, Visited);
 580   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
 581     // Same as above, but for ConstantExpr instead of Instruction.
 582     if (Instruction::isCast(CE->getOpcode())) {
 583       if (CastInst::isNoopCast(Instruction::CastOps(CE->getOpcode()),
 584                                CE->getOperand(0)->getType(),
 585                                CE->getType(),
 586                                TD ? TD->getIntPtrType(V->getContext()) :
 587                                     Type::getInt64Ty(V->getContext())))
 588         return findValueImpl(CE->getOperand(0), OffsetOk, Visited);
 589     } else if (CE->getOpcode() == Instruction::ExtractValue) {
 590       const SmallVector<unsigned, 4> &Indices = CE->getIndices();
 591       if (Value *W = FindInsertedValue(CE->getOperand(0),
 592                                        Indices.begin(),
 593                                        Indices.end()))
 594         if (W != V)
 595           return findValueImpl(W, OffsetOk, Visited);
 596     }
 597   }
 598
 599   // As a last resort, try SimplifyInstruction or constant folding.
 600   if (Instruction *Inst = dyn_cast<Instruction>(V)) {
 601     if (Value *W = SimplifyInstruction(Inst, TD))
 602       if (W != Inst)
 603         return findValueImpl(W, OffsetOk, Visited);
 604   } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
 605     if (Value *W = ConstantFoldConstantExpression(CE, TD))
 606       if (W != V)
 607         return findValueImpl(W, OffsetOk, Visited);
 608   }
 609
 610   return V;
 611 }
 612
 613 //===----------------------------------------------------------------------===//
 614 //  Implement the public interfaces to this file...
 615 //===----------------------------------------------------------------------===//
 616
 617 FunctionPass *llvm::createLintPass() {
 618   return new Lint();
 619 }
 620
 621 /// lintFunction - Check a function for errors, printing messages on stderr.
 622 ///
 623 void llvm::lintFunction(const Function &f) {
 624   Function &F = const_cast<Function&>(f);
 625   assert(!F.isDeclaration() && "Cannot lint external functions");
 626
 627   FunctionPassManager FPM(F.getParent());
 628   Lint *V = new Lint();
 629   FPM.add(V);
 630   FPM.run(F);
 631 }
 632
 633 /// lintModule - Check a module for errors, printing messages on stderr.
 634 ///
 635 void llvm::lintModule(const Module &M) {
 636   PassManager PM;
 637   Lint *V = new Lint();
 638   PM.add(V);
 639   PM.run(const_cast<Module&>(M));
 640 }