include/llvm/Analysis/ValueTracking.h

   1 //===- llvm/Analysis/ValueTracking.h - Walk computations --------*- C++ -*-===//
   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 file contains routines that help analyze properties that chains of
  11 // computations have.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_ANALYSIS_VALUETRACKING_H
  16 #define LLVM_ANALYSIS_VALUETRACKING_H
  17
  18 #include <string>
  19
  20 namespace llvm {
  21   class Value;
  22   class Instruction;
  23   class APInt;
  24   class TargetData;
  25
  26   /// ComputeMaskedBits - Determine which of the bits specified in Mask are
  27   /// known to be either zero or one and return them in the KnownZero/KnownOne
  28   /// bit sets.  This code only analyzes bits in Mask, in order to short-circuit
  29   /// processing.
  30   void ComputeMaskedBits(Value *V, const APInt &Mask, APInt &KnownZero,
  31                          APInt &KnownOne, TargetData *TD = 0,
  32                          unsigned Depth = 0);
  33
  34   /// MaskedValueIsZero - Return true if 'V & Mask' is known to be zero.  We use
  35   /// this predicate to simplify operations downstream.  Mask is known to be
  36   /// zero for bits that V cannot have.
  37   bool MaskedValueIsZero(Value *V, const APInt &Mask,
  38                          TargetData *TD = 0, unsigned Depth = 0);
  39
  40
  41   /// ComputeNumSignBits - Return the number of times the sign bit of the
  42   /// register is replicated into the other bits.  We know that at least 1 bit
  43   /// is always equal to the sign bit (itself), but other cases can give us
  44   /// information.  For example, immediately after an "ashr X, 2", we know that
  45   /// the top 3 bits are all equal to each other, so we return 3.
  46   ///
  47   /// 'Op' must have a scalar integer type.
  48   ///
  49   unsigned ComputeNumSignBits(Value *Op, TargetData *TD = 0,
  50                               unsigned Depth = 0);
  51
  52   /// CannotBeNegativeZero - Return true if we can prove that the specified FP
  53   /// value is never equal to -0.0.
  54   ///
  55   bool CannotBeNegativeZero(const Value *V, unsigned Depth = 0);
  56
  57   /// FindScalarValue - Given an aggregrate and an sequence of indices, see if
  58   /// the scalar value indexed is already around as a register, for example if
  59   /// it were inserted directly into the aggregrate.
  60   ///
  61   /// If InsertBefore is not null, this function will duplicate (modified)
  62   /// insertvalues when a part of a nested struct is extracted.
  63   Value *FindInsertedValue(Value *V,
  64                          const unsigned *idx_begin,
  65                          const unsigned *idx_end,
  66                          Instruction *InsertBefore = 0);
  67
  68   /// This is a convenience wrapper for finding values indexed by a single index
  69   /// only.
  70   inline Value *FindInsertedValue(Value *V, const unsigned Idx,
  71                                  Instruction *InsertBefore = 0) {
  72     const unsigned Idxs[1] = { Idx };
  73     return FindInsertedValue(V, &Idxs[0], &Idxs[1], InsertBefore);
  74   }
  75
  76   /// GetConstantStringInfo - This function computes the length of a
  77   /// null-terminated C string pointed to by V.  If successful, it returns true
  78   /// and returns the string in Str.  If unsuccessful, it returns false.
  79   bool GetConstantStringInfo(Value *V, std::string &Str, uint64_t Offset = 0);
  80 } // end namespace llvm
  81
  82 #endif