svf-lib 1.0.2319 → 1.0.2321

package/SVF-osx/Release-build/include/SVF/SVF-LLVM/LLVMUtil.h

@@ -0,0 +1,433 @@
+//===- 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"
+
+namespace SVF
+{
+
+namespace LLVMUtil
+{
+
+/// Whether an instruction is a call or invoke instruction
+inline bool isCallSite(const Instruction* inst)
+{
+    return SVFUtil::isa<CallBase>(inst);
+}
+/// Whether an instruction is a call or invoke instruction
+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);
+}
+
+/// Return LLVM callsite given a value
+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());
+}
+
+/// Return LLVM function if this value is
+inline const Function* getLLVMFunction(const Value* val)
+{
+    return SVFUtil::dyn_cast<Function>(val->stripPointerCasts());
+}
+
+/// Get program entry function from module.
+const Function* getProgFunction(const std::string& funName);
+
+/// Check whether a function is an entry function (i.e., main)
+inline bool isProgEntryFunction(const Function* fun)
+{
+    return fun && fun->getName() == "main";
+}
+
+/// Check whether this value is a black hole
+inline bool isBlackholeSym(const Value* val)
+{
+    return SVFUtil::isa<UndefValue>(val);
+}
+
+/// Check whether this value is a black hole
+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
+    assert(false && "llvm version 17+ only support opaque pointers!");
+#endif
+}
+
+/// Return size of this object based on LLVM value
+u32_t getNumOfElements(const Type* ety);
+
+
+/// Return true if this value refers to a object
+bool isObject(const Value* ref);
+
+/// Method for dead function, which does not have any possible caller
+/// function address is not taken and never be used in call or invoke instruction
+//@{
+/// whether this is a function without any possible caller?
+bool isUncalledFunction(const Function* fun);
+
+/// whether this is an argument in dead function
+inline bool ArgInDeadFunction(const Value* val)
+{
+    return SVFUtil::isa<Argument>(val)
+           && isUncalledFunction(SVFUtil::cast<Argument>(val)->getParent());
+}
+//@}
+
+/// Return true if this is an argument of a program entry function (e.g. main)
+inline bool ArgInProgEntryFunction(const Value* val)
+{
+    return SVFUtil::isa<Argument>(val) &&
+           LLVMUtil::isProgEntryFunction(
+               SVFUtil::cast<Argument>(val)->getParent());
+}
+/// Return true if this is value in a dead function (function without any caller)
+bool isPtrInUncalledFunction(const Value* value);
+//@}
+
+//@}
+
+/// Function does not have any possible caller in the call graph
+//@{
+/// Return true if the function does not have a caller (either it is a main function or a dead function)
+inline bool isNoCallerFunction(const Function* fun)
+{
+    return isUncalledFunction(fun) || LLVMUtil::isProgEntryFunction(fun);
+}
+
+/// Return true if the argument in a function does not have a caller
+inline bool isArgOfUncalledFunction (const Value*  val)
+{
+    return SVFUtil::isa<Argument>(val)
+           && isNoCallerFunction(SVFUtil::cast<Argument>(val)->getParent());
+}
+//@}
+
+/// Return true if the function has a return instruction
+bool basicBlockHasRetInst(const BasicBlock* bb);
+
+/// Return true if the function has a return instruction reachable from function
+/// entry
+bool functionDoesNotRet(const Function* fun);
+
+/// Get reachable basic block from function entry
+void getFunReachableBBs(const Function* svfFun,
+                        std::vector<const SVFBasicBlock*>& bbs);
+
+/// Strip off the constant casts
+const Value* stripConstantCasts(const Value* val);
+
+/// Strip off the all casts
+const Value* stripAllCasts(const Value* val);
+
+/// Return the bitcast instruction right next to val, otherwise
+/// return nullptr
+const Value* getFirstUseViaCastInst(const Value* val);
+
+/// Return corresponding constant expression, otherwise return nullptr
+//@{
+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)
+        dl = new DataLayout(mod);
+    return dl;
+}
+
+/// Get the next instructions following control flow
+void getNextInsts(const Instruction* curInst,
+                  std::vector<const Instruction*>& instList);
+
+
+/// Basic block does not have predecessors
+/// map-1.cpp.bc
+/// try.cont: ; No predecessors!
+///    call void @llvm.trap()
+///    unreachable
+inline bool isNoPrecessorBasicBlock(const BasicBlock* bb)
+{
+    return bb != &bb->getParent()->getEntryBlock() &&
+           pred_empty(bb);
+}
+
+/// Check whether a file is an LLVM IR file
+bool isIRFile(const std::string& filename);
+
+/// Parse argument for multi-module analysis
+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);
+
+/// Get all called funcions in a parent function
+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);
+
+/// Return true if the value refers to constant data, e.g., i32 0
+inline bool isConstDataOrAggData(const Value* val)
+{
+    return SVFUtil::isa<ConstantData, ConstantAggregate,
+           MetadataAsValue, BlockAddress>(val);
+}
+
+/// find the unique defined global across multiple modules
+const Value* getGlobalRep(const Value* val);
+
+/// Check whether this value points-to a constant object
+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);
+
+/// Whether an instruction is a callsite in the application code, excluding llvm intrinsic calls
+bool isNonInstricCallSite(const Instruction* inst);
+
+/// Get program entry function from module.
+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_ */

package/SVF-osx/Release-build/include/SVF/SVF-LLVM/ObjTypeInference.h

@@ -0,0 +1,129 @@
+//===- ObjTypeInference.h -- Type inference----------------------------//
+//
+//                     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/>.
+//
+//===----------------------------------------------------------------------===//
+
+/*
+ * ObjTypeInference.h
+ *
+ *  Created by Xiao Cheng on 10/01/24.
+ *
+ */
+
+#ifndef SVF_OBJTYPEINFERENCE_H
+#define SVF_OBJTYPEINFERENCE_H
+
+#include "Util/SVFUtil.h"
+#include "SVF-LLVM/BasicTypes.h"
+#include "Util/ThreadAPI.h"
+
+namespace SVF
+{
+class ObjTypeInference
+{
+
+public:
+    typedef Set<const Value *> ValueSet;
+    typedef Map<const Value *, ValueSet> ValueToValueSet;
+    typedef ValueToValueSet ValueToInferSites;
+    typedef ValueToValueSet ValueToSources;
+    typedef Map<const Value *, const Type *> ValueToType;
+    typedef std::pair<const Value *, bool> ValueBoolPair;
+    typedef Map<const Value *, Set<std::string>> ValueToClassNames;
+    typedef Map<const Value *, Set<const CallBase *>> ObjToClsNameSources;
+
+
+private:
+    ValueToInferSites _valueToInferSites; // value inference site cache
+    ValueToType _valueToType; // value type cache
+    ValueToSources _valueToAllocs; // value allocations (stack, static, heap) cache
+    ValueToClassNames _thisPtrClassNames; // thisptr class name cache
+    ValueToSources _valueToAllocOrClsNameSources; // value alloc/clsname sources cache
+    ObjToClsNameSources _objToClsNameSources; // alloc clsname sources cache
+
+
+public:
+
+    explicit ObjTypeInference() = default;
+
+    ~ObjTypeInference() = default;
+
+
+    /// get or infer the type of the object pointed by the value
+    const Type *inferObjType(const Value *var);
+
+    const Type *inferPointsToType(const Value *var);
+
+    /// validate type inference
+    void validateTypeCheck(const CallBase *cs);
+
+    void typeSizeDiffTest(const PointerType *oPTy, const Type *iTy, const Value *val);
+
+    /// default type
+    const Type *defaultType(const Value *val);
+
+    /// pointer type
+    inline const Type *ptrType()
+    {
+        return PointerType::getUnqual(getLLVMCtx());
+    }
+
+    /// int8 type
+    inline const IntegerType *int8Type()
+    {
+        return Type::getInt8Ty(getLLVMCtx());
+    }
+
+    LLVMContext &getLLVMCtx();
+
+private:
+
+    /// forward infer the type of the object pointed by var
+    const Type *fwInferObjType(const Value *var);
+
+    /// backward collect all possible allocation sites (stack, static, heap) of var
+    Set<const Value *>& bwfindAllocOfVar(const Value *var);
+
+    /// is allocation (stack, static, heap)
+    bool isAlloc(const SVF::Value *val);
+
+public:
+    /// select the largest (conservative) type from all types
+    const Type *selectLargestSizedType(Set<const Type *> &objTys);
+
+    u32_t objTyToNumFields(const Type *objTy);
+
+    u32_t getArgPosInCall(const CallBase *callBase, const Value *arg);
+
+public:
+    /// get or infer the class names of thisptr
+    Set<std::string> &inferThisPtrClsName(const Value *thisPtr);
+
+protected:
+
+    /// find all possible allocations or
+    /// class name sources (e.g., constructors/destructors or template functions) starting from a value
+    Set<const Value *> &bwFindAllocOrClsNameSources(const Value *startValue);
+
+    /// forward find class name sources starting from an allocation
+    Set<const CallBase *> &fwFindClsNameSources(const Value *startValue);
+};
+}
+#endif //SVF_OBJTYPEINFERENCE_H