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