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