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/Lint.h"
  39 #include "llvm/Analysis/ValueTracking.h"
  40 #include "llvm/Assembly/Writer.h"
  41 #include "llvm/Target/TargetData.h"
  42 #include "llvm/Pass.h"
  43 #include "llvm/PassManager.h"
  44 #include "llvm/IntrinsicInst.h"
  45 #include "llvm/Function.h"
  46 #include "llvm/Support/CallSite.h"
  47 #include "llvm/Support/Debug.h"
  48 #include "llvm/Support/InstVisitor.h"
  49 #include "llvm/Support/raw_ostream.h"
  50 #include "llvm/ADT/STLExtras.h"
  51 using namespace llvm;
  52
  53 namespace {
  54   namespace MemRef {
  55     static unsigned Read     = 1;
  56     static unsigned Write    = 2;
  57     static unsigned Callee   = 4;
  58     static unsigned Branchee = 8;
  59   }
  60
  61   class Lint : public FunctionPass, public InstVisitor<Lint> {
  62     friend class InstVisitor<Lint>;
  63
  64     void visitFunction(Function &F);
  65
  66     void visitCallSite(CallSite CS);
  67     void visitMemoryReference(Instruction &I, Value *Ptr, unsigned Align,
  68                               const Type *Ty, unsigned Flags);
  69
  70     void visitCallInst(CallInst &I);
  71     void visitInvokeInst(InvokeInst &I);
  72     void visitReturnInst(ReturnInst &I);
  73     void visitLoadInst(LoadInst &I);
  74     void visitStoreInst(StoreInst &I);
  75     void visitXor(BinaryOperator &I);
  76     void visitSub(BinaryOperator &I);
  77     void visitLShr(BinaryOperator &I);
  78     void visitAShr(BinaryOperator &I);
  79     void visitShl(BinaryOperator &I);
  80     void visitSDiv(BinaryOperator &I);
  81     void visitUDiv(BinaryOperator &I);
  82     void visitSRem(BinaryOperator &I);
  83     void visitURem(BinaryOperator &I);
  84     void visitAllocaInst(AllocaInst &I);
  85     void visitVAArgInst(VAArgInst &I);
  86     void visitIndirectBrInst(IndirectBrInst &I);
  87     void visitExtractElementInst(ExtractElementInst &I);
  88     void visitInsertElementInst(InsertElementInst &I);
  89     void visitUnreachableInst(UnreachableInst &I);
  90
  91   public:
  92     Module *Mod;
  93     AliasAnalysis *AA;
  94     TargetData *TD;
  95
  96     std::string Messages;
  97     raw_string_ostream MessagesStr;
  98
  99     static char ID; // Pass identification, replacement for typeid
 100     Lint() : FunctionPass(&ID), MessagesStr(Messages) {}
 101
 102     virtual bool runOnFunction(Function &F);
 103
 104     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
 105       AU.setPreservesAll();
 106       AU.addRequired<AliasAnalysis>();
 107     }
 108     virtual void print(raw_ostream &O, const Module *M) const {}
 109
 110     void WriteValue(const Value *V) {
 111       if (!V) return;
 112       if (isa<Instruction>(V)) {
 113         MessagesStr << *V << '\n';
 114       } else {
 115         WriteAsOperand(MessagesStr, V, true, Mod);
 116         MessagesStr << '\n';
 117       }
 118     }
 119
 120     void WriteType(const Type *T) {
 121       if (!T) return;
 122       MessagesStr << ' ';
 123       WriteTypeSymbolic(MessagesStr, T, Mod);
 124     }
 125
 126     // CheckFailed - A check failed, so print out the condition and the message
 127     // that failed.  This provides a nice place to put a breakpoint if you want
 128     // to see why something is not correct.
 129     void CheckFailed(const Twine &Message,
 130                      const Value *V1 = 0, const Value *V2 = 0,
 131                      const Value *V3 = 0, const Value *V4 = 0) {
 132       MessagesStr << Message.str() << "\n";
 133       WriteValue(V1);
 134       WriteValue(V2);
 135       WriteValue(V3);
 136       WriteValue(V4);
 137     }
 138
 139     void CheckFailed(const Twine &Message, const Value *V1,
 140                      const Type *T2, const Value *V3 = 0) {
 141       MessagesStr << Message.str() << "\n";
 142       WriteValue(V1);
 143       WriteType(T2);
 144       WriteValue(V3);
 145     }
 146
 147     void CheckFailed(const Twine &Message, const Type *T1,
 148                      const Type *T2 = 0, const Type *T3 = 0) {
 149       MessagesStr << Message.str() << "\n";
 150       WriteType(T1);
 151       WriteType(T2);
 152       WriteType(T3);
 153     }
 154   };
 155 }
 156
 157 char Lint::ID = 0;
 158 static RegisterPass<Lint>
 159 X("lint", "Statically lint-checks LLVM IR", false, true);
 160
 161 // Assert - We know that cond should be true, if not print an error message.
 162 #define Assert(C, M) \
 163     do { if (!(C)) { CheckFailed(M); return; } } while (0)
 164 #define Assert1(C, M, V1) \
 165     do { if (!(C)) { CheckFailed(M, V1); return; } } while (0)
 166 #define Assert2(C, M, V1, V2) \
 167     do { if (!(C)) { CheckFailed(M, V1, V2); return; } } while (0)
 168 #define Assert3(C, M, V1, V2, V3) \
 169     do { if (!(C)) { CheckFailed(M, V1, V2, V3); return; } } while (0)
 170 #define Assert4(C, M, V1, V2, V3, V4) \
 171     do { if (!(C)) { CheckFailed(M, V1, V2, V3, V4); return; } } while (0)
 172
 173 // Lint::run - This is the main Analysis entry point for a
 174 // function.
 175 //
 176 bool Lint::runOnFunction(Function &F) {
 177   Mod = F.getParent();
 178   AA = &getAnalysis<AliasAnalysis>();
 179   TD = getAnalysisIfAvailable<TargetData>();
 180   visit(F);
 181   dbgs() << MessagesStr.str();
 182   return false;
 183 }
 184
 185 void Lint::visitFunction(Function &F) {
 186   // This isn't undefined behavior, it's just a little unusual, and it's a
 187   // fairly common mistake to neglect to name a function.
 188   Assert1(F.hasName() || F.hasLocalLinkage(),
 189           "Unusual: Unnamed function with non-local linkage", &F);
 190 }
 191
 192 void Lint::visitCallSite(CallSite CS) {
 193   Instruction &I = *CS.getInstruction();
 194   Value *Callee = CS.getCalledValue();
 195
 196   visitMemoryReference(I, Callee, 0, 0, MemRef::Callee);
 197
 198   if (Function *F = dyn_cast<Function>(Callee->stripPointerCasts())) {
 199     Assert1(CS.getCallingConv() == F->getCallingConv(),
 200             "Undefined behavior: Caller and callee calling convention differ",
 201             &I);
 202
 203     const FunctionType *FT = F->getFunctionType();
 204     unsigned NumActualArgs = unsigned(CS.arg_end()-CS.arg_begin());
 205
 206     Assert1(FT->isVarArg() ?
 207               FT->getNumParams() <= NumActualArgs :
 208               FT->getNumParams() == NumActualArgs,
 209             "Undefined behavior: Call argument count mismatches callee "
 210             "argument count", &I);
 211
 212     // TODO: Check argument types (in case the callee was casted)
 213
 214     // TODO: Check ABI-significant attributes.
 215
 216     // TODO: Check noalias attribute.
 217
 218     // TODO: Check sret attribute.
 219   }
 220
 221   if (CS.isCall() && cast<CallInst>(CS.getInstruction())->isTailCall())
 222     for (CallSite::arg_iterator AI = CS.arg_begin(), AE = CS.arg_end();
 223          AI != AE; ++AI) {
 224       Value *Obj = (*AI)->getUnderlyingObject();
 225       Assert1(!isa<AllocaInst>(Obj) && !isa<VAArgInst>(Obj),
 226               "Undefined behavior: Call with \"tail\" keyword references "
 227               "alloca or va_arg", &I);
 228     }
 229
 230
 231   if (IntrinsicInst *II = dyn_cast<IntrinsicInst>(&I))
 232     switch (II->getIntrinsicID()) {
 233     default: break;
 234
 235     // TODO: Check more intrinsics
 236
 237     case Intrinsic::memcpy: {
 238       MemCpyInst *MCI = cast<MemCpyInst>(&I);
 239       visitMemoryReference(I, MCI->getSource(), MCI->getAlignment(), 0,
 240                            MemRef::Write);
 241       visitMemoryReference(I, MCI->getDest(), MCI->getAlignment(), 0,
 242                            MemRef::Read);
 243
 244       // Check that the memcpy arguments don't overlap. The AliasAnalysis API
 245       // isn't expressive enough for what we really want to do. Known partial
 246       // overlap is not distinguished from the case where nothing is known.
 247       unsigned Size = 0;
 248       if (const ConstantInt *Len =
 249             dyn_cast<ConstantInt>(MCI->getLength()->stripPointerCasts()))
 250         if (Len->getValue().isIntN(32))
 251           Size = Len->getValue().getZExtValue();
 252       Assert1(AA->alias(MCI->getSource(), Size, MCI->getDest(), Size) !=
 253               AliasAnalysis::MustAlias,
 254               "Undefined behavior: memcpy source and destination overlap", &I);
 255       break;
 256     }
 257     case Intrinsic::memmove: {
 258       MemMoveInst *MMI = cast<MemMoveInst>(&I);
 259       visitMemoryReference(I, MMI->getSource(), MMI->getAlignment(), 0,
 260                            MemRef::Write);
 261       visitMemoryReference(I, MMI->getDest(), MMI->getAlignment(), 0,
 262                            MemRef::Read);
 263       break;
 264     }
 265     case Intrinsic::memset: {
 266       MemSetInst *MSI = cast<MemSetInst>(&I);
 267       visitMemoryReference(I, MSI->getDest(), MSI->getAlignment(), 0,
 268                            MemRef::Write);
 269       break;
 270     }
 271
 272     case Intrinsic::vastart:
 273       Assert1(I.getParent()->getParent()->isVarArg(),
 274               "Undefined behavior: va_start called in a non-varargs function",
 275               &I);
 276
 277       visitMemoryReference(I, CS.getArgument(0), 0, 0,
 278                            MemRef::Read | MemRef::Write);
 279       break;
 280     case Intrinsic::vacopy:
 281       visitMemoryReference(I, CS.getArgument(0), 0, 0, MemRef::Write);
 282       visitMemoryReference(I, CS.getArgument(1), 0, 0, MemRef::Read);
 283       break;
 284     case Intrinsic::vaend:
 285       visitMemoryReference(I, CS.getArgument(0), 0, 0,
 286                            MemRef::Read | MemRef::Write);
 287       break;
 288
 289     case Intrinsic::stackrestore:
 290       visitMemoryReference(I, CS.getArgument(0), 0, 0,
 291                            MemRef::Read);
 292       break;
 293     }
 294 }
 295
 296 void Lint::visitCallInst(CallInst &I) {
 297   return visitCallSite(&I);
 298 }
 299
 300 void Lint::visitInvokeInst(InvokeInst &I) {
 301   return visitCallSite(&I);
 302 }
 303
 304 void Lint::visitReturnInst(ReturnInst &I) {
 305   Function *F = I.getParent()->getParent();
 306   Assert1(!F->doesNotReturn(),
 307           "Unusual: Return statement in function with noreturn attribute",
 308           &I);
 309 }
 310
 311 // TODO: Add a length argument and check that the reference is in bounds
 312 void Lint::visitMemoryReference(Instruction &I,
 313                                 Value *Ptr, unsigned Align, const Type *Ty,
 314                                 unsigned Flags) {
 315   Value *UnderlyingObject = Ptr->getUnderlyingObject();
 316   Assert1(!isa<ConstantPointerNull>(UnderlyingObject),
 317           "Undefined behavior: Null pointer dereference", &I);
 318   Assert1(!isa<UndefValue>(UnderlyingObject),
 319           "Undefined behavior: Undef pointer dereference", &I);
 320
 321   if (Flags & MemRef::Write) {
 322     if (const GlobalVariable *GV = dyn_cast<GlobalVariable>(UnderlyingObject))
 323       Assert1(!GV->isConstant(),
 324               "Undefined behavior: Write to read-only memory", &I);
 325     Assert1(!isa<Function>(UnderlyingObject) &&
 326             !isa<BlockAddress>(UnderlyingObject),
 327             "Undefined behavior: Write to text section", &I);
 328   }
 329   if (Flags & MemRef::Read) {
 330     Assert1(!isa<Function>(UnderlyingObject),
 331             "Unusual: Load from function body", &I);
 332     Assert1(!isa<BlockAddress>(UnderlyingObject),
 333             "Undefined behavior: Load from block address", &I);
 334   }
 335   if (Flags & MemRef::Callee) {
 336     Assert1(!isa<BlockAddress>(UnderlyingObject),
 337             "Undefined behavior: Call to block address", &I);
 338   }
 339   if (Flags & MemRef::Branchee) {
 340     Assert1(!isa<Constant>(UnderlyingObject) ||
 341             isa<BlockAddress>(UnderlyingObject),
 342             "Undefined behavior: Branch to non-blockaddress", &I);
 343   }
 344
 345   if (TD) {
 346     if (Align == 0 && Ty) Align = TD->getABITypeAlignment(Ty);
 347
 348     if (Align != 0) {
 349       unsigned BitWidth = TD->getTypeSizeInBits(Ptr->getType());
 350       APInt Mask = APInt::getAllOnesValue(BitWidth),
 351                    KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
 352       ComputeMaskedBits(Ptr, Mask, KnownZero, KnownOne, TD);
 353       Assert1(!(KnownOne & APInt::getLowBitsSet(BitWidth, Log2_32(Align))),
 354               "Undefined behavior: Memory reference address is misaligned", &I);
 355     }
 356   }
 357 }
 358
 359 void Lint::visitLoadInst(LoadInst &I) {
 360   visitMemoryReference(I, I.getPointerOperand(), I.getAlignment(), I.getType(),
 361                        MemRef::Read);
 362 }
 363
 364 void Lint::visitStoreInst(StoreInst &I) {
 365   visitMemoryReference(I, I.getPointerOperand(), I.getAlignment(),
 366                   I.getOperand(0)->getType(), MemRef::Write);
 367 }
 368
 369 void Lint::visitXor(BinaryOperator &I) {
 370   Assert1(!isa<UndefValue>(I.getOperand(0)) ||
 371           !isa<UndefValue>(I.getOperand(1)),
 372           "Undefined result: xor(undef, undef)", &I);
 373 }
 374
 375 void Lint::visitSub(BinaryOperator &I) {
 376   Assert1(!isa<UndefValue>(I.getOperand(0)) ||
 377           !isa<UndefValue>(I.getOperand(1)),
 378           "Undefined result: sub(undef, undef)", &I);
 379 }
 380
 381 void Lint::visitLShr(BinaryOperator &I) {
 382   if (ConstantInt *CI =
 383         dyn_cast<ConstantInt>(I.getOperand(1)->stripPointerCasts()))
 384     Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
 385             "Undefined result: Shift count out of range", &I);
 386 }
 387
 388 void Lint::visitAShr(BinaryOperator &I) {
 389   if (ConstantInt *CI =
 390         dyn_cast<ConstantInt>(I.getOperand(1)->stripPointerCasts()))
 391     Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
 392             "Undefined result: Shift count out of range", &I);
 393 }
 394
 395 void Lint::visitShl(BinaryOperator &I) {
 396   if (ConstantInt *CI =
 397         dyn_cast<ConstantInt>(I.getOperand(1)->stripPointerCasts()))
 398     Assert1(CI->getValue().ult(cast<IntegerType>(I.getType())->getBitWidth()),
 399             "Undefined result: Shift count out of range", &I);
 400 }
 401
 402 static bool isZero(Value *V, TargetData *TD) {
 403   // Assume undef could be zero.
 404   if (isa<UndefValue>(V)) return true;
 405
 406   unsigned BitWidth = cast<IntegerType>(V->getType())->getBitWidth();
 407   APInt Mask = APInt::getAllOnesValue(BitWidth),
 408                KnownZero(BitWidth, 0), KnownOne(BitWidth, 0);
 409   ComputeMaskedBits(V, Mask, KnownZero, KnownOne, TD);
 410   return KnownZero.isAllOnesValue();
 411 }
 412
 413 void Lint::visitSDiv(BinaryOperator &I) {
 414   Assert1(!isZero(I.getOperand(1), TD),
 415           "Undefined behavior: Division by zero", &I);
 416 }
 417
 418 void Lint::visitUDiv(BinaryOperator &I) {
 419   Assert1(!isZero(I.getOperand(1), TD),
 420           "Undefined behavior: Division by zero", &I);
 421 }
 422
 423 void Lint::visitSRem(BinaryOperator &I) {
 424   Assert1(!isZero(I.getOperand(1), TD),
 425           "Undefined behavior: Division by zero", &I);
 426 }
 427
 428 void Lint::visitURem(BinaryOperator &I) {
 429   Assert1(!isZero(I.getOperand(1), TD),
 430           "Undefined behavior: Division by zero", &I);
 431 }
 432
 433 void Lint::visitAllocaInst(AllocaInst &I) {
 434   if (isa<ConstantInt>(I.getArraySize()))
 435     // This isn't undefined behavior, it's just an obvious pessimization.
 436     Assert1(&I.getParent()->getParent()->getEntryBlock() == I.getParent(),
 437             "Pessimization: Static alloca outside of entry block", &I);
 438 }
 439
 440 void Lint::visitVAArgInst(VAArgInst &I) {
 441   visitMemoryReference(I, I.getOperand(0), 0, 0,
 442                        MemRef::Read | MemRef::Write);
 443 }
 444
 445 void Lint::visitIndirectBrInst(IndirectBrInst &I) {
 446   visitMemoryReference(I, I.getAddress(), 0, 0, MemRef::Branchee);
 447 }
 448
 449 void Lint::visitExtractElementInst(ExtractElementInst &I) {
 450   if (ConstantInt *CI =
 451         dyn_cast<ConstantInt>(I.getIndexOperand()->stripPointerCasts()))
 452     Assert1(CI->getValue().ult(I.getVectorOperandType()->getNumElements()),
 453             "Undefined result: extractelement index out of range", &I);
 454 }
 455
 456 void Lint::visitInsertElementInst(InsertElementInst &I) {
 457   if (ConstantInt *CI =
 458         dyn_cast<ConstantInt>(I.getOperand(2)->stripPointerCasts()))
 459     Assert1(CI->getValue().ult(I.getType()->getNumElements()),
 460             "Undefined result: insertelement index out of range", &I);
 461 }
 462
 463 void Lint::visitUnreachableInst(UnreachableInst &I) {
 464   // This isn't undefined behavior, it's merely suspicious.
 465   Assert1(&I == I.getParent()->begin() ||
 466           prior(BasicBlock::iterator(&I))->mayHaveSideEffects(),
 467           "Unusual: unreachable immediately preceded by instruction without "
 468           "side effects", &I);
 469 }
 470
 471 //===----------------------------------------------------------------------===//
 472 //  Implement the public interfaces to this file...
 473 //===----------------------------------------------------------------------===//
 474
 475 FunctionPass *llvm::createLintPass() {
 476   return new Lint();
 477 }
 478
 479 /// lintFunction - Check a function for errors, printing messages on stderr.
 480 ///
 481 void llvm::lintFunction(const Function &f) {
 482   Function &F = const_cast<Function&>(f);
 483   assert(!F.isDeclaration() && "Cannot lint external functions");
 484
 485   FunctionPassManager FPM(F.getParent());
 486   Lint *V = new Lint();
 487   FPM.add(V);
 488   FPM.run(F);
 489 }
 490
 491 /// lintModule - Check a module for errors, printing messages on stderr.
 492 /// Return true if the module is corrupt.
 493 ///
 494 void llvm::lintModule(const Module &M, std::string *ErrorInfo) {
 495   PassManager PM;
 496   Lint *V = new Lint();
 497   PM.add(V);
 498   PM.run(const_cast<Module&>(M));
 499
 500   if (ErrorInfo)
 501     *ErrorInfo = V->MessagesStr.str();
 502 }