Options.h

Go to the documentation of this file.

//===- Options.h -- Command line options ------------------------//
 
#ifndef OPTIONS_H_
#define OPTIONS_H_
 
#include <sstream>
#include "FastCluster/fastcluster.h"
#include "Util/CommandLine.h"
#include "Util/PTAStat.h"
#include "MemoryModel/PointerAnalysisImpl.h"
#include "Util/NodeIDAllocator.h"
#include "MSSA/MemSSA.h"
#include "WPA/WPAPass.h"
#include "AE/Svfexe/AbstractInterpretation.h"
 
namespace SVF
{
 
class Options
{
public:
    Options(void) = delete;
 
    static const OptionMap<enum PTAStat::ClockType> ClockType;
 
    static const Option<bool> MarkedClocksOnly;
 
    static const OptionMap<SVF::NodeIDAllocator::Strategy> NodeAllocStrat;
 
    static const Option<u32_t> MaxFieldLimit;
 
    static const Option<bool> ClusterAnder;
 
    static const Option<bool> ClusterFs;
 
    static const Option<bool> PlainMappingFs;
 
    static const OptionMap<PointsTo::Type> PtType;
 
    static const OptionMap<enum hclust_fast_methods> ClusterMethod;
 
    static const Option<bool> RegionedClustering;
 
    static const Option<bool> RegionAlign;
 
    static const Option<bool> PredictPtOcc;
 
    static const OptionMap<BVDataPTAImpl::PTBackingType> ptDataBacking;
 
    static const Option<u32_t> FsTimeLimit;
 
    static const Option<u32_t> AnderTimeLimit;
 
    static const Option<u32_t> VersioningThreads;
 
    // ContextDDA.cpp
    static const Option<u32_t> CxtBudget;
 
    // DDAPass.cpp
    static const Option<u32_t> MaxPathLen;
    static const Option<u32_t> MaxContextLen;
    static const Option<u32_t> MaxStepInWrapper;
    static const Option<std::string> UserInputQuery;
    static const Option<bool> InsenRecur;
    static const Option<bool> InsenCycle;
    static const Option<bool> PrintCPts;
    static const Option<bool> PrintQueryPts;
    static const Option<bool> WPANum;
    static OptionMultiple<PointerAnalysis::PTATY> DDASelected;
 
    // FlowDDA.cpp
    static const Option<u32_t> FlowBudget;
 
    // Offline constraint graph (OfflineConsG.cpp)
    static const Option<bool> OCGDotGraph;
 
    // Program Assignment Graph for pointer analysis (SVFIR.cpp)
    static Option<bool> HandBlackHole;
    static const Option<bool> FirstFieldEqBase;
 
    // SVFG optimizer (SVFGOPT.cpp)
    static const Option<bool> ContextInsensitive;
    static const Option<bool> KeepAOFI;
    static const Option<std::string> SelfCycle;
 
    // Sparse value-flow graph (VFG.cpp)
    static const Option<bool> DumpVFG;
 
    // Base class of pointer analyses (PointerAnalysis.cpp)
    static const Option<bool> TypePrint;
    static const Option<bool> FuncPointerPrint;
    static const Option<bool> PTSPrint;
    static const Option<bool> PTSAllPrint;
    static const Option<bool> PrintFieldWithBasePrefix;
    static const Option<bool> PStat;
    static const Option<u32_t> StatBudget;
    static const Option<bool> PAGDotGraph;
    static const Option<bool> ShowSVFIRValue;
    static const Option<bool> DumpICFG;
    static const Option<std::string> DumpJson;
    static const Option<bool> ReadJson;
    static const Option<bool> CallGraphDotGraph;
    static const Option<bool> PAGPrint;
    static const Option<u32_t> IndirectCallLimit;
    static Option<bool> UsePreCompFieldSensitive;
    static const Option<bool> EnableAliasCheck;
    static const Option<bool> EnableTypeCheck;
    static const Option<bool> EnableThreadCallGraph;
    static const Option<bool> ConnectVCallOnCHA;
 
    // PointerAnalysisImpl.cpp
    static const Option<bool> INCDFPTData;
 
    // Memory region (MemRegion.cpp)
    static const Option<bool> IgnoreDeadFun;
 
    // Base class of pointer analyses (MemSSA.cpp)
    static const Option<bool> DumpMSSA;
    static const Option<std::string> MSSAFun;
    // static const llvm::cl::opt<string> MSSAFun;
    static const OptionMap<MemSSA::MemPartition> MemPar;
 
    // SVFG builder (SVFGBuilder.cpp)
    static const Option<bool> SVFGWithIndirectCall;
    static Option<bool> OPTSVFG;
 
    static const Option<std::string> WriteSVFG;
    static const Option<std::string> ReadSVFG;
 
    // LockAnalysis.cpp
    static const Option<bool> IntraLock;
    static const Option<bool> PrintLockSpan;
 
    // MHP.cpp
    static const Option<bool> PrintInterLev;
    static const Option<bool> DoLockAnalysis;
 
    //MTAStat.cpp
    static const Option<bool> AllPairMHP;
 
    // TCT.cpp
    static const Option<bool> TCTDotGraph;
 
    // LeakChecker.cpp
    static const Option<bool> ValidateTests;
 
    // Source-sink analyzer (SrcSnkDDA.cpp)
    static const Option<bool> DumpSlice;
    static const Option<u32_t> CxtLimit;
 
    // CHG.cpp
    static const Option<bool> DumpCHA;
 
    // DCHG.cpp
    static const Option<bool> PrintDCHG;
 
    // LLVMModule.cpp
    static const Option<std::string> Graphtxt;
    static const Option<bool> SVFMain;
 
    // SymbolTableInfo.cpp
    static const Option<bool> LocMemModel;
    static Option<bool> ModelConsts;
    static Option<bool> ModelArrays;
    static const Option<bool> CyclicFldIdx;
    static const Option<bool> SymTabPrint;
 
    // Conditions.cpp
    static const Option<u32_t> MaxZ3Size;
 
    // BoundedZ3Expr.cpp
    static const Option<u32_t> MaxBVLen;
 
    // SaberCondAllocator.cpp
    static const Option<bool> PrintPathCond;
 
    // SaberSVFGBuilder.cpp
    static const Option<bool> CollectExtRetGlobals;
 
    // SVFUtil.cpp
    static const Option<bool> DisableWarn;
 
    // Andersen.cpp
    static const Option<bool> ConsCGDotGraph;
    static const Option<bool> BriefConsCGDotGraph;
    static const Option<bool> PrintCGGraph;
    // static const Option<string> WriteAnder;
    static const Option<std::string> WriteAnder;
    // static const Option<string> ReadAnder;
    static const Option<std::string> ReadAnder;
    static const Option<bool> DiffPts;
    static Option<bool> DetectPWC;
    static const Option<bool> VtableInSVFIR;
 
    // WPAPass.cpp
    static const Option<std::string> ExtAPIPath;
    static const Option<bool> AnderSVFG;
    static const Option<bool> SABERFULLSVFG;
    static const Option<bool> PrintAliases;
    static OptionMultiple<PointerAnalysis::PTATY> PASelected;
    static OptionMultiple<WPAPass::AliasCheckRule> AliasRule;
 
    // DOTGraphTraits
    static const Option<bool> ShowHiddenNode;
 
    // CFL option
    static const Option<std::string> GrammarFilename;
    static const Option<std::string> CFLGraph;
    static const Option<bool> PrintCFL;
    static const Option<bool> FlexSymMap;
    static const Option<bool>  PEGTransfer;
    static const Option<bool>  CFLSVFG;
    static const Option<bool> POCRAlias;
    static const Option<bool> POCRHybrid;
    static const Option<bool> Customized;
 
    // Loop Analysis
    static const Option<bool> LoopAnalysis;
    static const Option<u32_t> LoopBound;
 
    // Abstract Execution
    static const Option<u32_t> WidenDelay;
    static const OptionMap<AbstractInterpretation::HandleRecur> HandleRecur;
    static const Option<u32_t> Timeout;
    static const Option<std::string> OutputName;
    static const Option<bool> BufferOverflowCheck;
    static const Option<bool> NullDerefCheck;
    static const Option<bool> MemoryLeakCheck;
    static const Option<bool> FileCheck;
    static const Option<bool> DFreeCheck;
    static const Option<bool> RaceCheck;
    static const Option<bool> GepUnknownIdx;
    static const Option<bool> RunUncallFuncs;
 
    static const Option<bool> ICFGMergeAdjacentNodes;
 
    // float precision for symbolic abstraction
    static const Option<u32_t> AEPrecision;
};
}  // namespace SVF
 
#endif  // ifdef OPTIONS_H_