IFDSSolver (soot-infoflow 2.10.4 API)

java.lang.Object
- soot.jimple.infoflow.solver.gcSolver.IFDSSolver<N,D,I>

类型参数:

N - The type of nodes in the interprocedural control-flow graph. Typically Unit.

D - The type of data-flow facts to be computed by the tabulation problem.

I - The type of inter-procedural control-flow graph being used.

所有已实现的接口:

IMemoryBoundedSolver

直接已知子类:

InfoflowSolver
```
public class IFDSSolver<N,D extends FastSolverLinkedNode<D,N>,I extends soot.jimple.toolkits.ide.icfg.BiDiInterproceduralCFG<N,soot.SootMethod>>
extends Object
implements IMemoryBoundedSolver
```
A solver for an IFDSTabulationProblem. This solver is not based on the IDESolver implementation in Heros for performance reasons.

另请参阅:

IFDSTabulationProblem

嵌套类概要

嵌套类
限定符和类型类和说明

protected static class IFDSSolver.IncomingRecord<N,D extends FastSolverLinkedNode<D,N>>
- 从接口继承的嵌套类/接口 soot.jimple.infoflow.memory.IMemoryBoundedSolver
  IMemoryBoundedSolver.IMemoryBoundedSolverStatusNotification

嵌套类
限定符和类型	类和说明
`protected static class`	`IFDSSolver.IncomingRecord<N,D extends FastSolverLinkedNode<D,N>>`

字段概要

字段
限定符和类型	字段和说明
`static boolean`	`DEBUG`
`static com.google.common.cache.CacheBuilder<Object,Object>`	`DEFAULT_CACHE_BUILDER`
`protected MyConcurrentHashMap<heros.solver.Pair<soot.SootMethod,D>,Map<heros.solver.Pair<N,D>,D>>`	`endSummary`
`protected InterruptableExecutor`	`executor`
`protected heros.FlowFunctionCache<N,D,soot.SootMethod>`	`ffCache`
`protected heros.FlowFunctions<N,D,soot.SootMethod>`	`flowFunctions`
`protected boolean`	`followReturnsPastSeeds`
`protected IGarbageCollector<N,D>`	`garbageCollector`
`protected I`	`icfg`
`protected soot.util.ConcurrentHashMultiMap<heros.solver.Pair<soot.SootMethod,D>,IFDSSolver.IncomingRecord<N,D>>`	`incoming`
`protected Map<N,Set<D>>`	`initialSeeds`
`protected soot.util.ConcurrentHashMultiMap<soot.SootMethod,heros.solver.PathEdge<N,D>>`	`jumpFunctions`
`protected static org.slf4j.Logger`	`logger`
`protected IMemoryManager<D,N>`	`memoryManager`
`protected int`	`numThreads`
`long`	`propagationCount`
`protected PredecessorShorteningMode`	`shorteningMode`
`protected boolean`	`solverId`
`protected SolverPeerGroup`	`solverPeerGroup`
`protected D`	`zeroValue`

构造器概要

构造器
构造器和说明
`IFDSSolver(heros.IFDSTabulationProblem<N,D,soot.SootMethod,I> tabulationProblem)` Creates a solver for the given problem, which caches flow functions and edge functions.
`IFDSSolver(heros.IFDSTabulationProblem<N,D,soot.SootMethod,I> tabulationProblem, com.google.common.cache.CacheBuilder flowFunctionCacheBuilder)` Creates a solver for the given problem, constructing caches with the given `CacheBuilder`.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`D`	`addFunction(heros.solver.PathEdge<N,D> edge)` Records a jump function.
`protected boolean`	`addIncoming(soot.SootMethod m, D d3, N n, D d1, D d2)`
`void`	`addStatusListener(IMemoryBoundedSolver.IMemoryBoundedSolverStatusNotification listener)` Adds a new listener that will be notified of status changes in the solver
`protected boolean`	`applyEndSummaryOnCall(D d1, N n, D d2, Collection<N> returnSiteNs, soot.SootMethod sCalledProcN, D d3)`
`protected void`	`awaitCompletionComputeValuesAndShutdown()` Awaits the completion of the exploded super graph.
`protected Set<D>`	`computeCallFlowFunction(heros.FlowFunction<D> callFlowFunction, D d1, D d2)` Computes the call flow function for the given call-site abstraction
`protected Set<D>`	`computeCallToReturnFlowFunction(heros.FlowFunction<D> callToReturnFlowFunction, D d1, D d2)` Computes the call-to-return flow function for the given call-site abstraction
`protected Set<D>`	`computeNormalFlowFunction(heros.FlowFunction<D> flowFunction, D d1, D d2)` Computes the normal flow function for the given set of start and end abstractions.
`protected Set<D>`	`computeReturnFlowFunction(heros.FlowFunction<D> retFunction, D d1, D d2, N callSite, Collection<D> callerSideDs)` Computes the return flow function for the given set of caller-side abstractions.
`protected IGarbageCollector<N,D>`	`createGarbageCollector()` Factory method for creating an instance of the garbage collector
`protected Map<heros.solver.Pair<N,D>,D>`	`endSummaryMap(soot.SootMethod m, D d3)`
`void`	`forceTerminate(ISolverTerminationReason reason)` Forces the solver to terminate its tasks and stop processing new tasks.
`protected String`	`getDebugName()` Returns a String used to identify the output of this solver in debug mode.
`protected InterruptableExecutor`	`getExecutor()` Factory method for this solver's thread-pool executor.
`IMemoryManager<D,N>`	`getMemoryManager()` Gets the memory manager used by this solver to reduce memory consumption
`ISolverTerminationReason`	`getTerminationReason()` In case this solver was killed before it could complete its task, this method returns the reason for the abortion.
`protected Set<IFDSSolver.IncomingRecord<N,D>>`	`incoming(D d1, soot.SootMethod m)`
`boolean`	`isKilled()` Checks whether this solver was killed before it could complete its tasks
`boolean`	`isTerminated()` Checks whether this solver is terminated, either by forced termination, or because it has finished all of its work.
`void`	`printStats()`
`protected void`	`processExit(heros.solver.PathEdge<N,D> edge)` Lines 21-32 of the algorithm.
`protected void`	`propagate(D sourceVal, N target, D targetVal, N relatedCallSite, boolean isUnbalancedReturn)` Propagates the flow further down the exploded super graph.
`void`	`reset()` Resets the solver to its initial state after it has been forcefully terminated.
`protected void`	`scheduleEdgeProcessing(heros.solver.PathEdge<N,D> edge)` Dispatch the processing of a given edge.
`void`	`setMaxAbstractionPathLength(int maxAbstractionPathLength)`
`void`	`setMaxCalleesPerCallSite(int maxCalleesPerCallSite)`
`void`	`setMaxJoinPointAbstractions(int maxJoinPointAbstractions)` Sets the maximum number of abstractions that shall be recorded per join point.
`void`	`setMemoryManager(IMemoryManager<D,N> memoryManager)` Sets the memory manager that shall be used to manage the abstractions
`void`	`setPeerGroup(SolverPeerGroup solverPeerGroup)` Sets the peer group in which this solver operates.
`void`	`setPredecessorShorteningMode(PredecessorShorteningMode mode)` Sets whether abstractions on method returns shall be connected to the respective call abstractions to shortcut paths.
`void`	`setSolverId(boolean solverId)`
`void`	`solve()` Runs the solver on the configured problem.
`protected void`	`submitInitialSeeds()` Schedules the processing of initial seeds, initiating the analysis.
`void`	`terminate()` Notifies the solver that no further edges will be scheduled

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DEFAULT_CACHE_BUILDER
```
public static com.google.common.cache.CacheBuilder<Object,Object> DEFAULT_CACHE_BUILDER
```
  - logger
```
protected static final org.slf4j.Logger logger
```
  - DEBUG
```
public static final boolean DEBUG
```
  - executor
```
protected InterruptableExecutor executor
```
  - numThreads
```
protected int numThreads
```
  - jumpFunctions
```
protected soot.util.ConcurrentHashMultiMap<soot.SootMethod,heros.solver.PathEdge<N,D extends FastSolverLinkedNode<D,N>>> jumpFunctions
```
  - garbageCollector
```
protected volatile IGarbageCollector<N,D extends FastSolverLinkedNode<D,N>> garbageCollector
```
  - icfg
```
protected final I extends soot.jimple.toolkits.ide.icfg.BiDiInterproceduralCFG<N,soot.SootMethod> icfg
```
  - endSummary
```
protected final MyConcurrentHashMap<heros.solver.Pair<soot.SootMethod,D extends FastSolverLinkedNode<D,N>>,Map<heros.solver.Pair<N,D extends FastSolverLinkedNode<D,N>>,D extends FastSolverLinkedNode<D,N>>> endSummary
```
  - incoming
```
protected final soot.util.ConcurrentHashMultiMap<heros.solver.Pair<soot.SootMethod,D extends FastSolverLinkedNode<D,N>>,IFDSSolver.IncomingRecord<N,D extends FastSolverLinkedNode<D,N>>> incoming
```
  - flowFunctions
```
protected final heros.FlowFunctions<N,D extends FastSolverLinkedNode<D,N>,soot.SootMethod> flowFunctions
```
  - initialSeeds
```
protected final Map<N,Set<D extends FastSolverLinkedNode<D,N>>> initialSeeds
```
  - propagationCount
```
public long propagationCount
```
  - zeroValue
```
protected final D extends FastSolverLinkedNode<D,N> zeroValue
```
  - ffCache
```
protected final heros.FlowFunctionCache<N,D extends FastSolverLinkedNode<D,N>,soot.SootMethod> ffCache
```
  - followReturnsPastSeeds
```
protected final boolean followReturnsPastSeeds
```
  - shorteningMode
```
protected PredecessorShorteningMode shorteningMode
```
  - memoryManager
```
protected IMemoryManager<D extends FastSolverLinkedNode<D,N>,N> memoryManager
```
  - solverId
```
protected boolean solverId
```
  - solverPeerGroup
```
protected SolverPeerGroup solverPeerGroup
```
- 构造器详细资料
  - IFDSSolver
```
public IFDSSolver(heros.IFDSTabulationProblem<N,D,soot.SootMethod,I> tabulationProblem)
```
    Creates a solver for the given problem, which caches flow functions and edge functions. The solver must then be started by calling solve().
  - IFDSSolver
```
public IFDSSolver(heros.IFDSTabulationProblem<N,D,soot.SootMethod,I> tabulationProblem,
                  com.google.common.cache.CacheBuilder flowFunctionCacheBuilder)
```
    Creates a solver for the given problem, constructing caches with the given CacheBuilder. The solver must then be started by calling solve().
    
    参数:
    
    tabulationProblem - The tabulation problem to solve
    
    flowFunctionCacheBuilder - A valid CacheBuilder or null if no caching is to be used for flow functions.
- 方法详细资料
  - createGarbageCollector
```
protected IGarbageCollector<N,D> createGarbageCollector()
```
    Factory method for creating an instance of the garbage collector
    
    返回:
    
    The new garbage collector
  - setSolverId
```
public void setSolverId(boolean solverId)
```
  - solve
```
public void solve()
```
    Runs the solver on the configured problem. This can take some time.
  - submitInitialSeeds
```
protected void submitInitialSeeds()
```
    Schedules the processing of initial seeds, initiating the analysis. Clients should only call this methods if performing synchronization on their own. Normally, solve() should be called instead.
  - awaitCompletionComputeValuesAndShutdown
```
protected void awaitCompletionComputeValuesAndShutdown()
```
    Awaits the completion of the exploded super graph. When complete, computes result values, shuts down the executor and returns.
  - scheduleEdgeProcessing
```
protected void scheduleEdgeProcessing(heros.solver.PathEdge<N,D> edge)
```
    Dispatch the processing of a given edge. It may be executed in a different thread.
    
    参数:
    
    edge - the edge to process
  - applyEndSummaryOnCall
```
protected boolean applyEndSummaryOnCall(D d1,
                                        N n,
                                        D d2,
                                        Collection<N> returnSiteNs,
                                        soot.SootMethod sCalledProcN,
                                        D d3)
```
  - computeCallFlowFunction
```
protected Set<D> computeCallFlowFunction(heros.FlowFunction<D> callFlowFunction,
                                         D d1,
                                         D d2)
```
    Computes the call flow function for the given call-site abstraction
    
    参数:
    
    callFlowFunction - The call flow function to compute
    
    d1 - The abstraction at the current method's start node.
    
    d2 - The abstraction at the call site
    
    返回:
    
    The set of caller-side abstractions at the callee's start node
  - computeCallToReturnFlowFunction
```
protected Set<D> computeCallToReturnFlowFunction(heros.FlowFunction<D> callToReturnFlowFunction,
                                                 D d1,
                                                 D d2)
```
    Computes the call-to-return flow function for the given call-site abstraction
    
    参数:
    
    callToReturnFlowFunction - The call-to-return flow function to compute
    
    d1 - The abstraction at the current method's start node.
    
    d2 - The abstraction at the call site
    
    返回:
    
    The set of caller-side abstractions at the return site
  - processExit
```
protected void processExit(heros.solver.PathEdge<N,D> edge)
```
    Lines 21-32 of the algorithm. Stores callee-side summaries. Also, at the side of the caller, propagates intra-procedural flows to return sites using those newly computed summaries.
    
    参数:
    
    edge - an edge whose target node resembles a method exits
  - computeReturnFlowFunction
```
protected Set<D> computeReturnFlowFunction(heros.FlowFunction<D> retFunction,
                                           D d1,
                                           D d2,
                                           N callSite,
                                           Collection<D> callerSideDs)
```
    Computes the return flow function for the given set of caller-side abstractions.
    
    参数:
    
    retFunction - The return flow function to compute
    
    d1 - The abstraction at the beginning of the callee
    
    d2 - The abstraction at the exit node in the callee
    
    callSite - The call site
    
    callerSideDs - The abstractions at the call site
    
    返回:
    
    The set of caller-side abstractions at the return site
  - computeNormalFlowFunction
```
protected Set<D> computeNormalFlowFunction(heros.FlowFunction<D> flowFunction,
                                           D d1,
                                           D d2)
```
    Computes the normal flow function for the given set of start and end abstractions.
    
    参数:
    
    flowFunction - The normal flow function to compute
    
    d1 - The abstraction at the method's start node
    
    d2 - The abstraction at the current node
    
    返回:
    
    The set of abstractions at the successor node
  - propagate
```
protected void propagate(D sourceVal,
                         N target,
                         D targetVal,
                         N relatedCallSite,
                         boolean isUnbalancedReturn)
```
    Propagates the flow further down the exploded super graph.
    
    参数:
    
    sourceVal - the source value of the propagated summary edge
    
    target - the target statement
    
    targetVal - the target value at the target statement
    
    relatedCallSite - for call and return flows the related call statement, null otherwise (this value is not used within this implementation but may be useful for subclasses of IFDSSolver)
    
    isUnbalancedReturn - true if this edge is propagating an unbalanced return (this value is not used within this implementation but may be useful for subclasses of IFDSSolver)
  - addFunction
```
public D addFunction(heros.solver.PathEdge<N,D> edge)
```
    Records a jump function. The source statement is implicit.
    
    另请参阅:
    
    PathEdge
  - endSummaryMap
```
protected Map<heros.solver.Pair<N,D>,D> endSummaryMap(soot.SootMethod m,
                                                      D d3)
```
  - incoming
```
protected Set<IFDSSolver.IncomingRecord<N,D>> incoming(D d1,
                                                       soot.SootMethod m)
```
  - addIncoming
```
protected boolean addIncoming(soot.SootMethod m,
                              D d3,
                              N n,
                              D d1,
                              D d2)
```
  - getExecutor
```
protected InterruptableExecutor getExecutor()
```
    Factory method for this solver's thread-pool executor.
  - getDebugName
```
protected String getDebugName()
```
    Returns a String used to identify the output of this solver in debug mode. Subclasses can overwrite this string to distinguish the output from different solvers.
  - printStats
```
public void printStats()
```
  - setPredecessorShorteningMode
```
public void setPredecessorShorteningMode(PredecessorShorteningMode mode)
```
    Sets whether abstractions on method returns shall be connected to the respective call abstractions to shortcut paths.
    
    参数:
    
    mode - The strategy to use for shortening predecessor paths
  - setMaxJoinPointAbstractions
```
public void setMaxJoinPointAbstractions(int maxJoinPointAbstractions)
```
    Sets the maximum number of abstractions that shall be recorded per join point. In other words, enabling this option disables the recording of neighbors beyond the given count.
    
    参数:
    
    maxJoinPointAbstractions - The maximum number of abstractions per join point, or -1 to record an arbitrary number of join point abstractions
  - setMemoryManager
```
public void setMemoryManager(IMemoryManager<D,N> memoryManager)
```
    Sets the memory manager that shall be used to manage the abstractions
    
    参数:
    
    memoryManager - The memory manager that shall be used to manage the abstractions
  - getMemoryManager
```
public IMemoryManager<D,N> getMemoryManager()
```
    Gets the memory manager used by this solver to reduce memory consumption
    
    返回:
    
    The memory manager registered with this solver
  - forceTerminate
```
public void forceTerminate(ISolverTerminationReason reason)
```
    从接口复制的说明: IMemoryBoundedSolver
    
    Forces the solver to terminate its tasks and stop processing new tasks. This will kill the solver.
    
    指定者:
    
    forceTerminate 在接口中 IMemoryBoundedSolver
    
    参数:
    
    reason - The reason why the solver is terminated
  - isTerminated
```
public boolean isTerminated()
```
    从接口复制的说明: IMemoryBoundedSolver
    
    Checks whether this solver is terminated, either by forced termination, or because it has finished all of its work.
    
    指定者:
    
    isTerminated 在接口中 IMemoryBoundedSolver
    
    返回:
    
    True if this solver is terminated, otherwise false
  - isKilled
```
public boolean isKilled()
```
    从接口复制的说明: IMemoryBoundedSolver
    
    Checks whether this solver was killed before it could complete its tasks
    
    指定者:
    
    isKilled 在接口中 IMemoryBoundedSolver
    
    返回:
    
    True if this solver was killed before it could complete its tasks, otherwise false
  - reset
```
public void reset()
```
    从接口复制的说明: IMemoryBoundedSolver
    
    Resets the solver to its initial state after it has been forcefully terminated. After calling this method, the solver is expected to accept new tasks.
    
    指定者:
    
    reset 在接口中 IMemoryBoundedSolver
  - addStatusListener
```
public void addStatusListener(IMemoryBoundedSolver.IMemoryBoundedSolverStatusNotification listener)
```
    从接口复制的说明: IMemoryBoundedSolver
    
    Adds a new listener that will be notified of status changes in the solver
    
    指定者:
    
    addStatusListener 在接口中 IMemoryBoundedSolver
    
    参数:
    
    listener - The listener that will be notified when the status of the solver changes
  - getTerminationReason
```
public ISolverTerminationReason getTerminationReason()
```
    从接口复制的说明: IMemoryBoundedSolver
    
    In case this solver was killed before it could complete its task, this method returns the reason for the abortion. Otherwise, this method returns null.
    
    指定者:
    
    getTerminationReason 在接口中 IMemoryBoundedSolver
    
    返回:
    
    The reason for the abortion in case the solver was killed, otherwise null
  - setMaxCalleesPerCallSite
```
public void setMaxCalleesPerCallSite(int maxCalleesPerCallSite)
```
  - setMaxAbstractionPathLength
```
public void setMaxAbstractionPathLength(int maxAbstractionPathLength)
```
  - setPeerGroup
```
public void setPeerGroup(SolverPeerGroup solverPeerGroup)
```
    Sets the peer group in which this solver operates. Peer groups allow for synchronization between solvers
    
    参数:
    
    solverPeerGroup - The solver peer group
  - terminate
```
public void terminate()
```
    Notifies the solver that no further edges will be scheduled

类 IFDSSolver<N,D extends FastSolverLinkedNode<D,N>,I extends soot.jimple.toolkits.ide.icfg.BiDiInterproceduralCFG<N,soot.SootMethod>>

嵌套类概要

从接口继承的嵌套类/接口 soot.jimple.infoflow.memory.IMemoryBoundedSolver

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT_CACHE_BUILDER

logger

DEBUG

executor

numThreads

jumpFunctions

garbageCollector

icfg

endSummary

incoming

flowFunctions

initialSeeds

propagationCount

zeroValue

ffCache

followReturnsPastSeeds

shorteningMode

memoryManager

solverId

solverPeerGroup

构造器详细资料

IFDSSolver

IFDSSolver

方法详细资料

createGarbageCollector

setSolverId

solve

submitInitialSeeds

awaitCompletionComputeValuesAndShutdown

scheduleEdgeProcessing

applyEndSummaryOnCall

computeCallFlowFunction

computeCallToReturnFlowFunction

processExit

computeReturnFlowFunction

computeNormalFlowFunction

propagate

addFunction

endSummaryMap

incoming

addIncoming

getExecutor

getDebugName

printStats

setPredecessorShorteningMode

setMaxJoinPointAbstractions

setMemoryManager

getMemoryManager

forceTerminate

isTerminated

isKilled

reset

addStatusListener

getTerminationReason

setMaxCalleesPerCallSite

setMaxAbstractionPathLength

setPeerGroup

terminate