LLVMUtil.h

Go to the documentation of this file.

//===- LLVMUtil.h -- Analysis helper functions----------------------------//
//
//                     SVF: Static Value-Flow Analysis
//
// Copyright (C) <2013->  <Yulei Sui>
//
 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
 
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
//===----------------------------------------------------------------------===//
 
/*
 * LLVMUtil.h
 *
 *  Created on: Apr 11, 2013
 *      Author: Yulei Sui
 */
 
#ifndef INCLUDE_SVF_FE_LLVMUTIL_H_
#define INCLUDE_SVF_FE_LLVMUTIL_H_
 
#include "Util/SVFUtil.h"
#include "SVF-LLVM/BasicTypes.h"
#include "Util/ThreadAPI.h"
#include "Util/Options.h"
 
#include <llvm/Config/llvm-config.h>
#if LLVM_VERSION_MAJOR < 16
#include <llvm/ADT/Triple.h>
#else
#include <llvm/TargetParser/Triple.h>
#endif
 
namespace SVF
{
 
enum class TargetABI
{
    Itanium,
    MSVC,
};
 
class SVFBasicBlock;
 
namespace LLVMUtil
{
 
inline bool isCallSite(const Instruction* inst)
{
    return SVFUtil::isa<CallBase>(inst);
}
inline bool isCallSite(const Value* val)
{
    return SVFUtil::isa<CallBase>(val);
}
 
inline double getDoubleValue(const ConstantFP* fpValue)
{
    double dval = 0;
    if (fpValue->isNormalFP())
    {
        const llvm::fltSemantics& semantics = fpValue->getValueAPF().getSemantics();
        if (&semantics == &llvm::APFloat::IEEEhalf() ||
                &semantics == &llvm::APFloat::IEEEsingle() ||
                &semantics == &llvm::APFloat::IEEEdouble() ||
                &semantics == &llvm::APFloat::IEEEquad() ||
                &semantics == &llvm::APFloat::x87DoubleExtended())
        {
            dval = fpValue->getValueAPF().convertToDouble();
        }
        else
        {
            assert (false && "Unsupported floating point type");
            abort();
        }
    }
    else
    {
        // other cfp type, like isZero(), isInfinity(), isNegative(), etc.
        // do nothing
    }
    return dval;
}
 
inline std::pair<s64_t, u64_t> getIntegerValue(const ConstantInt* intValue)
{
    if (intValue->getBitWidth() <= 64 && intValue->getBitWidth() >= 1)
        return std::make_pair(intValue->getSExtValue(), intValue->getZExtValue());
    else
        return std::make_pair(0,0);
}
 
inline const CallBase* getLLVMCallSite(const Value* value)
{
    assert(isCallSite(value) && "not a callsite?");
    return SVFUtil::cast<CallBase>(value);
}
 
inline const Function* getCallee(const CallBase* cs)
{
    // FIXME: do we need to strip-off the casts here to discover more library functions
    return SVFUtil::dyn_cast<Function>(cs->getCalledOperand()->stripPointerCasts());
}
 
inline const Function* getLLVMFunction(const Value* val)
{
    return SVFUtil::dyn_cast<Function>(val->stripPointerCasts());
}
 
const Function* getProgFunction(const std::string& funName);
 
inline bool isProgEntryFunction(const Function* fun)
{
    const char* main_name=Options::SVFMain() ? "svf.main" : "main";
    return fun && fun->getName() == main_name;
}
 
inline bool isBlackholeSym(const Value* val)
{
    return SVFUtil::isa<UndefValue>(val);
}
 
inline bool isNullPtrSym(const Value* val)
{
    return SVFUtil::dyn_cast<ConstantPointerNull>(val);
}
 
static inline Type* getPtrElementType(const PointerType* pty)
{
#if (LLVM_VERSION_MAJOR < 14)
    return pty->getPointerElementType();
#elif (LLVM_VERSION_MAJOR < 17)
    assert(!pty->isOpaque() && "Opaque Pointer is used, please recompile the source adding '-Xclang -no-opaque-pointers'");
    return pty->getNonOpaquePointerElementType();
#else
    (void)pty; // Suppress warning of unused variable under release build
    assert(false && "llvm version 17+ only support opaque pointers!");
    return nullptr;
#endif
}
 
u32_t getNumOfElements(const Type* ety);
 
 
bool isObject(const Value* ref);
 
 
 
bool isUncalledFunction(const Function* fun);
 
inline bool ArgInDeadFunction(const Value* val)
{
    return SVFUtil::isa<Argument>(val)
           && isUncalledFunction(SVFUtil::cast<Argument>(val)->getParent());
}
 
inline bool ArgInProgEntryFunction(const Value* val)
{
    return SVFUtil::isa<Argument>(val) &&
           LLVMUtil::isProgEntryFunction(
               SVFUtil::cast<Argument>(val)->getParent());
}
bool isPtrInUncalledFunction(const Value* value);
 
 
 
 
inline bool isNoCallerFunction(const Function* fun)
{
    return isUncalledFunction(fun) || LLVMUtil::isProgEntryFunction(fun);
}
 
inline bool isArgOfUncalledFunction (const Value*  val)
{
    return SVFUtil::isa<Argument>(val)
           && isNoCallerFunction(SVFUtil::cast<Argument>(val)->getParent());
}
 
bool basicBlockHasRetInst(const BasicBlock* bb);
 
bool functionDoesNotRet(const Function* fun);
 
void getFunReachableBBs(const Function* svfFun,
                        std::vector<const SVFBasicBlock*>& bbs);
 
const Value* stripConstantCasts(const Value* val);
 
const Value* stripAllCasts(const Value* val);
 
const Value* getFirstUseViaCastInst(const Value* val);
 
 
inline const ConstantExpr* isGepConstantExpr(const Value* val)
{
    if (const ConstantExpr* constExpr = SVFUtil::dyn_cast<ConstantExpr>(val))
    {
        if (constExpr->getOpcode() == Instruction::GetElementPtr)
            return constExpr;
    }
    return nullptr;
}
 
inline const ConstantExpr* isInt2PtrConstantExpr(const Value* val)
{
    if (const ConstantExpr* constExpr = SVFUtil::dyn_cast<ConstantExpr>(val))
    {
        if (constExpr->getOpcode() == Instruction::IntToPtr)
            return constExpr;
    }
    return nullptr;
}
 
inline const ConstantExpr* isPtr2IntConstantExpr(const Value* val)
{
    if (const ConstantExpr* constExpr = SVFUtil::dyn_cast<ConstantExpr>(val))
    {
        if (constExpr->getOpcode() == Instruction::PtrToInt)
            return constExpr;
    }
    return nullptr;
}
 
inline const ConstantExpr* isCastConstantExpr(const Value* val)
{
    if (const ConstantExpr* constExpr = SVFUtil::dyn_cast<ConstantExpr>(val))
    {
        if (constExpr->getOpcode() == Instruction::BitCast)
            return constExpr;
    }
    return nullptr;
}
 
inline const ConstantExpr* isSelectConstantExpr(const Value* val)
{
    if (const ConstantExpr* constExpr = SVFUtil::dyn_cast<ConstantExpr>(val))
    {
        if (constExpr->getOpcode() == Instruction::Select)
            return constExpr;
    }
    return nullptr;
}
 
inline const ConstantExpr* isTruncConstantExpr(const Value* val)
{
    if (const ConstantExpr* constExpr = SVFUtil::dyn_cast<ConstantExpr>(val))
    {
        if (constExpr->getOpcode() == Instruction::Trunc ||
                constExpr->getOpcode() == Instruction::FPTrunc ||
                constExpr->getOpcode() == Instruction::ZExt ||
                constExpr->getOpcode() == Instruction::SExt ||
                constExpr->getOpcode() == Instruction::FPExt)
            return constExpr;
    }
    return nullptr;
}
 
inline const ConstantExpr* isCmpConstantExpr(const Value* val)
{
    if (const ConstantExpr* constExpr = SVFUtil::dyn_cast<ConstantExpr>(val))
    {
        if (constExpr->getOpcode() == Instruction::ICmp ||
                constExpr->getOpcode() == Instruction::FCmp)
            return constExpr;
    }
    return nullptr;
}
 
inline const ConstantExpr* isBinaryConstantExpr(const Value* val)
{
    if (const ConstantExpr* constExpr = SVFUtil::dyn_cast<ConstantExpr>(val))
    {
        if ((constExpr->getOpcode() >= Instruction::BinaryOpsBegin) &&
                (constExpr->getOpcode() <= Instruction::BinaryOpsEnd))
            return constExpr;
    }
    return nullptr;
}
 
inline const ConstantExpr* isUnaryConstantExpr(const Value* val)
{
    if (const ConstantExpr* constExpr = SVFUtil::dyn_cast<ConstantExpr>(val))
    {
        if ((constExpr->getOpcode() >= Instruction::UnaryOpsBegin) &&
                (constExpr->getOpcode() <= Instruction::UnaryOpsEnd))
            return constExpr;
    }
    return nullptr;
}
 
inline static DataLayout* getDataLayout(Module* mod)
{
    static DataLayout *dl = nullptr;
    if (dl == nullptr)
#if LLVM_VERSION_MAJOR >= 19
        dl = new DataLayout(mod->getDataLayout());
#else
        dl = new DataLayout(mod);
#endif
    return dl;
}
 
inline static llvm::Triple getTargetTriple(const Module* mod)
{
    assert(mod && "null module");
#if LLVM_VERSION_MAJOR >= 21
    return mod->getTargetTriple();
#else
    return llvm::Triple(mod->getTargetTriple());
#endif
}
 
inline static TargetABI detectTargetABI(const llvm::Triple &triple)
{
    if (triple.isWindowsMSVCEnvironment())
        return TargetABI::MSVC;
 
    if (triple.isWindowsItaniumEnvironment() ||
            triple.isWindowsGNUEnvironment() ||
            triple.isWindowsCygwinEnvironment())
        return TargetABI::Itanium;
 
    return TargetABI::Itanium;
}
 
void getNextInsts(const Instruction* curInst,
                  std::vector<const Instruction*>& instList);
 
 
inline bool isNoPrecessorBasicBlock(const BasicBlock* bb)
{
    return bb != &bb->getParent()->getEntryBlock() &&
           pred_empty(bb);
}
 
bool isIRFile(const std::string& filename);
 
void processArguments(int argc, char** argv, int& arg_num, char** arg_value,
                      std::vector<std::string>& moduleNameVec);
 
 
const std::string getSourceLoc(const Value* val);
const std::string getSourceLocOfFunction(const Function* F);
 
bool isIntrinsicInst(const Instruction* inst);
bool isIntrinsicFun(const Function* func);
 
std::vector<const Function *> getCalledFunctions(const Function *F);
// Converts a mangled name to C naming style to match functions in extapi.c.
std::string restoreFuncName(std::string funcName);
 
bool isExtCall(const Function* fun);
 
bool isMemcpyExtFun(const Function *fun);
 
bool isMemsetExtFun(const Function* fun);
 
u32_t getHeapAllocHoldingArgPosition(const Function* fun);
 
const FunObjVar* getFunObjVar(const std::string&name);
 
inline bool isConstDataOrAggData(const Value* val)
{
    return SVFUtil::isa<ConstantData, ConstantAggregate,
           MetadataAsValue, BlockAddress>(val);
}
 
const Value* getGlobalRep(const Value* val);
 
bool isConstantObjSym(const Value* val);
 
// Dump Control Flow Graph of llvm function, with instructions
void viewCFG(const Function* fun);
 
// Dump Control Flow Graph of llvm function, without instructions
void viewCFGOnly(const Function* fun);
 
std::string dumpValue(const Value* val);
 
std::string dumpType(const Type* type);
 
std::string dumpValueAndDbgInfo(const Value* val);
 
bool isHeapAllocExtCallViaRet(const Instruction *inst);
 
bool isHeapAllocExtCallViaArg(const Instruction *inst);
 
inline bool isHeapAllocExtCall(const Instruction *inst)
{
    return isHeapAllocExtCallViaRet(inst) || isHeapAllocExtCallViaArg(inst);
}
 
bool isStackAllocExtCallViaRet(const Instruction *inst);
 
inline bool isStackAllocExtCall(const Instruction *inst)
{
    return isStackAllocExtCallViaRet(inst);
}
 
// Check if a given value represents a heap object.
bool isHeapObj(const Value* val);
 
// Check if a given value represents a stack object.
bool isStackObj(const Value* val);
 
bool isNonInstricCallSite(const Instruction* inst);
 
inline const Function* getProgEntryFunction(Module& module)
{
    for (auto it = module.begin(), eit = module.end(); it != eit; ++it)
    {
        const Function *fun = &(*it);
        if (isProgEntryFunction(fun))
            return (fun);
    }
    return nullptr;
}
 
} // End namespace LLVMUtil
 
} // End namespace SVF
 
#endif /* INCLUDE_SVF_FE_LLVMUTIL_H_ */