dk.brics.tajs.monitoring

Class TogglableMonitor

java.lang.Object

dk.brics.tajs.monitoring.TogglableMonitor

All Implemented Interfaces:

ILatticeMonitoring, IAnalysisMonitoring, ISolverMonitoring<State,Context>

public class TogglableMonitor
extends java.lang.Object
implements IAnalysisMonitoring

Decorator monitor that can be toggled on and off.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TogglableMonitor.Toggler

Constructor Summary

Constructors

Constructor and Description
TogglableMonitor(IAnalysisMonitoring togglable)

Method Summary

Modifier and Type	Method and Description
void	addMessage(AbstractNode n, Message.Severity severity, java.lang.String msg) Adds a message for the given node.
void	addMessage(AbstractNode n, Message.Severity severity, java.lang.String key, java.lang.String msg) Adds a message for the given node.
void	addMessageInfo(AbstractNode n, Message.Severity severity, java.lang.String msg) Adds a message for the given node.
boolean	allowNextIteration() Returns true if the fixpoint solver should continue with its next iteration or abort early and unsoundly.
TogglableMonitor.Toggler	getController()
java.util.Set<Message>	getMessages() Returns the collected messages.
java.util.Map<TypeCollector.VariableSummary,Value>	getTypeInformation() Returns the collected type information.
void	setSolverInterface(GenericSolver.SolverInterface c) Sets the solver interface which will be used by the analysis.
void	visitBlockTransferPost(BasicBlock b, State s) Invoked immediately after processing a block transfer.
void	visitBlockTransferPre(BasicBlock b, State s) Invoked immediately before processing a block transfer.
void	visitCall(AbstractNode n, Value funval) Invoked when a function call occurs.
void	visitEvalCall(AbstractNode n, Value v) Invoked when a call to eval occurs.
void	visitEventHandlerRegistration(AbstractNode node, Context context, Value handler) Invoked when an event handler is registered.
void	visitFunction(Function f, java.util.Collection<State> entry_states) Invoked when a function is encountered in the scan phase.
void	visitIf(IfNode n, Value v) Invoked when a IfNode is processed.
void	visitIn(AbstractNode n, boolean maybe_v2_object, boolean maybe_v2_nonobject) Invoked when an 'in' operation is processed.
void	visitInnerHTMLWrite(Node n, Value v) Invoked when a write to innerHTML occurs.
void	visitInstanceof(AbstractNode n, boolean maybe_v2_non_function, boolean maybe_v2_function, boolean maybe_v2_prototype_primitive, boolean maybe_v2_prototype_nonprimitive) Invoked when an 'instanceof' operation is processed.
void	visitIterationDone(java.lang.String terminatedEarlyMsg) Invoked when dataflow solver iteration is done (not necessarily with success).
void	visitJoin(long ms) Invoked when a state join operation is performed.
void	visitNativeFunctionCall(AbstractNode n, HostObject hostobject, boolean num_actuals_unknown, int num_actuals, int min, int max) Invoked when a call to a native function occurs.
void	visitNativeFunctionReturn(AbstractNode node, HostObject hostObject, Value result) Invoked when returning from a native function call.
void	visitNewFlow(BasicBlock b, Context c, State s, java.lang.String diff, java.lang.String info) Invoked when new dataflow is being propagated.
void	visitNewObject(AbstractNode node, ObjectLabel label, State s) Invoked when a new abstract object is allocated.
void	visitNodeTransferPost(AbstractNode n, State s) Invoked immediately after processing a node transfer.
void	visitNodeTransferPre(AbstractNode n, State s) Invoked immediately before processing a node transfer.
void	visitPhasePost(AnalysisPhase phase) Invoked at the end of a phase.
void	visitPhasePre(AnalysisPhase phase) Invoked at the beginning of a phase.
void	visitPropagationPost(BlockAndContext<Context> from, BlockAndContext<Context> to, boolean changed) Invoked immediately after propagating dataflow from one location to another.
void	visitPropagationPre(BlockAndContext<Context> from, BlockAndContext<Context> to) Invoked immediately before propagating dataflow from one location to another.
void	visitPropertyAccess(Node n, Value baseval) Invoked when a property access occurs.
void	visitPropertyRead(AbstractNode n, java.util.Set<ObjectLabel> objs, PKeys propertyname, State state, boolean check_unknown) Invoked when a property read operation cccurs.
void	visitPropertyWrite(Node n, java.util.Set<ObjectLabel> objs, PKeys propertyname) Invoked when a property write operation cccurs.
void	visitRead(Node n, Value v, State state) Invoked when a variable or property read operation cccurs.
void	visitReadNonThisVariable(ReadVariableNode n, Value v) Invoked when a non-this variable read operation cccurs.
void	visitReadProperty(ReadPropertyNode n, java.util.Set<ObjectLabel> objlabels, PKeys propertyname, boolean maybe, State state, Value v, ObjectLabel global_objv) Invoked when a property read operation cccurs.
void	visitReadThis(ReadVariableNode n, Value v, State state, ObjectLabel global_obj) Invoked when 'this' is read.
void	visitReadVariable(ReadVariableNode n, Value v, State state) Invoked when a variable read operation occurs.
void	visitRecoveryGraph(AbstractNode node, int size) Invoked when a recovery graph has been built.
void	visitRenameObject(AbstractNode node, ObjectLabel from, ObjectLabel to, State s) Invoked when an abstract object changes name (from singleton to summary for recency abstraction).
void	visitUnknownValueResolve(AbstractNode node, boolean partial, boolean scanning) Invoked when an unknown value is resolved.
void	visitUserFunctionCall(Function f, AbstractNode call, boolean constructor) Invoked when a user-function call occurs.
void	visitVariableAsRead(AbstractNode n, java.lang.String varname, Value v, State state) Invoked when a variable read operation occurs.
void	visitVariableOrProperty(AbstractNode node, java.lang.String var, SourceLocation loc, Value value, Context context, State state) Invoked when a variable or property is read or written.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TogglableMonitor

public TogglableMonitor(IAnalysisMonitoring togglable)

Method Detail

addMessage

public void addMessage(AbstractNode n,
                       Message.Severity severity,
                       java.lang.String msg)

Description copied from interface: IAnalysisMonitoring

Adds a message for the given node. If not in scan phase, nothing is done. Uses Status.MAYBE. Uses the message as key (must be a fixed string).

Specified by:

addMessage in interface IAnalysisMonitoring

addMessage

public void addMessage(AbstractNode n,
                       Message.Severity severity,
                       java.lang.String key,
                       java.lang.String msg)

Description copied from interface: IAnalysisMonitoring

Adds a message for the given node. If not in scan phase, nothing is done. Uses Status.MAYBE. The key must be a fixed string.

Specified by:

addMessage in interface IAnalysisMonitoring

addMessageInfo

public void addMessageInfo(AbstractNode n,
                           Message.Severity severity,
                           java.lang.String msg)

Description copied from interface: IAnalysisMonitoring

Adds a message for the given node. If not in scan phase, nothing is done. Uses Status.INFO. Uses the message as key (must be a fixed string).

Specified by:

addMessageInfo in interface IAnalysisMonitoring

allowNextIteration

public boolean allowNextIteration()

Description copied from interface: ISolverMonitoring

Returns true if the fixpoint solver should continue with its next iteration or abort early and unsoundly.

Specified by:

allowNextIteration in interface ISolverMonitoring<State,Context>

getController

public TogglableMonitor.Toggler getController()

getMessages

public java.util.Set<Message> getMessages()

Description copied from interface: IAnalysisMonitoring

Returns the collected messages. (Used by the Eclipse plugin.)

Specified by:

getMessages in interface IAnalysisMonitoring

getTypeInformation

public java.util.Map<TypeCollector.VariableSummary,Value> getTypeInformation()

Description copied from interface: IAnalysisMonitoring

Returns the collected type information. (Used by the Eclipse plugin.)

Specified by:

getTypeInformation in interface IAnalysisMonitoring

setSolverInterface

public void setSolverInterface(GenericSolver.SolverInterface c)

Description copied from interface: IAnalysisMonitoring

Sets the solver interface which will be used by the analysis.

Specified by:

setSolverInterface in interface IAnalysisMonitoring

visitBlockTransferPost

public void visitBlockTransferPost(BasicBlock b,
                                   State s)

Description copied from interface: ISolverMonitoring

Invoked immediately after processing a block transfer.

Specified by:

visitBlockTransferPost in interface ISolverMonitoring<State,Context>

visitBlockTransferPre

public void visitBlockTransferPre(BasicBlock b,
                                  State s)

Description copied from interface: ISolverMonitoring

Invoked immediately before processing a block transfer.

Specified by:

visitBlockTransferPre in interface ISolverMonitoring<State,Context>

visitCall

public void visitCall(AbstractNode n,
                      Value funval)

Description copied from interface: IAnalysisMonitoring

Invoked when a function call occurs.

Specified by:

visitCall in interface IAnalysisMonitoring

Parameters:

n - node responsible for the call

funval - the function value

visitEvalCall

public void visitEvalCall(AbstractNode n,
                          Value v)

Description copied from interface: IAnalysisMonitoring

Invoked when a call to eval occurs.

Specified by:

visitEvalCall in interface IAnalysisMonitoring

Parameters:

n - node that may call eval

v - value being eval'ed

visitEventHandlerRegistration

public void visitEventHandlerRegistration(AbstractNode node,
                                          Context context,
                                          Value handler)

Description copied from interface: IAnalysisMonitoring

Invoked when an event handler is registered.

Specified by:

visitEventHandlerRegistration in interface IAnalysisMonitoring

visitFunction

public void visitFunction(Function f,
                          java.util.Collection<State> entry_states)

Description copied from interface: ISolverMonitoring

Invoked when a function is encountered in the scan phase. (Invoked once on each function.)

Specified by:

visitFunction in interface ISolverMonitoring<State,Context>

visitIf

public void visitIf(IfNode n,
                    Value v)

Description copied from interface: IAnalysisMonitoring

Invoked when a IfNode is processed.

Specified by:

visitIf in interface IAnalysisMonitoring

Parameters:

n - if node

v - the boolean value

visitIn

public void visitIn(AbstractNode n,
                    boolean maybe_v2_object,
                    boolean maybe_v2_nonobject)

Description copied from interface: IAnalysisMonitoring

Invoked when an 'in' operation is processed.

Specified by:

visitIn in interface IAnalysisMonitoring

Parameters:

n - node performing the operation

maybe_v2_object - if the second parameter may be an object value

maybe_v2_nonobject - if the second parameter may be a non-object value

visitInnerHTMLWrite

public void visitInnerHTMLWrite(Node n,
                                Value v)

Description copied from interface: IAnalysisMonitoring

Invoked when a write to innerHTML occurs.

Specified by:

visitInnerHTMLWrite in interface IAnalysisMonitoring

Parameters:

n - node where the write occurs

v - value being written

visitInstanceof

public void visitInstanceof(AbstractNode n,
                            boolean maybe_v2_non_function,
                            boolean maybe_v2_function,
                            boolean maybe_v2_prototype_primitive,
                            boolean maybe_v2_prototype_nonprimitive)

Description copied from interface: IAnalysisMonitoring

Invoked when an 'instanceof' operation is processed.

Specified by:

visitInstanceof in interface IAnalysisMonitoring

Parameters:

n - node performing the operation

maybe_v2_non_function - set if the second parameter may be a non-function value

maybe_v2_function - set if the second parameter may be a function value

maybe_v2_prototype_primitive - set if the prototype property of the second parameter may be a primitive value

maybe_v2_prototype_nonprimitive - set if the prototype property of the second parameter may be an object value

visitIterationDone

public void visitIterationDone(java.lang.String terminatedEarlyMsg)

Description copied from interface: ISolverMonitoring

Invoked when dataflow solver iteration is done (not necessarily with success).

Specified by:

visitIterationDone in interface ISolverMonitoring<State,Context>

Parameters:

terminatedEarlyMsg - message about premature termination, if non-null

visitJoin

public void visitJoin(long ms)

Description copied from interface: ILatticeMonitoring

Invoked when a state join operation is performed.

Specified by:

visitJoin in interface ILatticeMonitoring

Parameters:

ms - time used by the join operation

visitNativeFunctionCall

public void visitNativeFunctionCall(AbstractNode n,
                                    HostObject hostobject,
                                    boolean num_actuals_unknown,
                                    int num_actuals,
                                    int min,
                                    int max)

Description copied from interface: IAnalysisMonitoring

Invoked when a call to a native function occurs.

Specified by:

visitNativeFunctionCall in interface IAnalysisMonitoring

Parameters:

n - node responsible for the call

hostobject - the native function being called

num_actuals_unknown - if set, the number of actuals is unknown

num_actuals - number of actuals (if num_actuals_unknown is not set)

min - minimum number of parameters expected

max - maximum number of paramaters expected (-1 for any number)

visitNativeFunctionReturn

public void visitNativeFunctionReturn(AbstractNode node,
                                      HostObject hostObject,
                                      Value result)

Description copied from interface: IAnalysisMonitoring

Invoked when returning from a native function call.

Specified by:

visitNativeFunctionReturn in interface IAnalysisMonitoring

visitNewFlow

public void visitNewFlow(BasicBlock b,
                         Context c,
                         State s,
                         java.lang.String diff,
                         java.lang.String info)

Description copied from interface: ISolverMonitoring

Invoked when new dataflow is being propagated.

Specified by:

visitNewFlow in interface ISolverMonitoring<State,Context>

visitNewObject

public void visitNewObject(AbstractNode node,
                           ObjectLabel label,
                           State s)

Description copied from interface: ILatticeMonitoring

Invoked when a new abstract object is allocated.

Specified by:

visitNewObject in interface ILatticeMonitoring

visitNodeTransferPost

public void visitNodeTransferPost(AbstractNode n,
                                  State s)

Description copied from interface: ISolverMonitoring

Invoked immediately after processing a node transfer.

Specified by:

visitNodeTransferPost in interface ISolverMonitoring<State,Context>

visitNodeTransferPre

public void visitNodeTransferPre(AbstractNode n,
                                 State s)

Description copied from interface: ISolverMonitoring

Invoked immediately before processing a node transfer.

Specified by:

visitNodeTransferPre in interface ISolverMonitoring<State,Context>

visitPhasePost

public void visitPhasePost(AnalysisPhase phase)

Description copied from interface: IAnalysisMonitoring

Invoked at the end of a phase.

Specified by:

visitPhasePost in interface IAnalysisMonitoring

visitPhasePre

public void visitPhasePre(AnalysisPhase phase)

Description copied from interface: IAnalysisMonitoring

Invoked at the beginning of a phase.

Specified by:

visitPhasePre in interface IAnalysisMonitoring

visitPropagationPost

public void visitPropagationPost(BlockAndContext<Context> from,
                                 BlockAndContext<Context> to,
                                 boolean changed)

Description copied from interface: ISolverMonitoring

Invoked immediately after propagating dataflow from one location to another.

Specified by:

visitPropagationPost in interface ISolverMonitoring<State,Context>

changed - true if the destination state was changed

See Also:

ISolverMonitoring.visitPropagationPre(BlockAndContext, BlockAndContext)

visitPropagationPre

public void visitPropagationPre(BlockAndContext<Context> from,
                                BlockAndContext<Context> to)

Description copied from interface: ISolverMonitoring

Invoked immediately before propagating dataflow from one location to another. (This does not include the merging of states that occurs in some specialized transfers, such as ParallelTransfer.)

Specified by:

visitPropagationPre in interface ISolverMonitoring<State,Context>

visitPropertyAccess

public void visitPropertyAccess(Node n,
                                Value baseval)

Description copied from interface: IAnalysisMonitoring

Invoked when a property access occurs.

Specified by:

visitPropertyAccess in interface IAnalysisMonitoring

Parameters:

n - operation that accesses a property

baseval - base value for the access

visitPropertyRead

public void visitPropertyRead(AbstractNode n,
                              java.util.Set<ObjectLabel> objs,
                              PKeys propertyname,
                              State state,
                              boolean check_unknown)

Description copied from interface: IAnalysisMonitoring

Invoked when a property read operation cccurs.

Specified by:

visitPropertyRead in interface IAnalysisMonitoring

Parameters:

n - the node responsible for the read

objs - the objects being read from

propertyname - description of the property name

check_unknown - if set, warn about reads from unknown properties

visitPropertyWrite

public void visitPropertyWrite(Node n,
                               java.util.Set<ObjectLabel> objs,
                               PKeys propertyname)

Description copied from interface: IAnalysisMonitoring

Invoked when a property write operation cccurs.

Specified by:

visitPropertyWrite in interface IAnalysisMonitoring

Parameters:

n - the node responsible for the write

objs - the objects being written to

propertyname - description of the property name

visitRead

public void visitRead(Node n,
                      Value v,
                      State state)

Description copied from interface: IAnalysisMonitoring

Invoked when a variable or property read operation cccurs.

Specified by:

visitRead in interface IAnalysisMonitoring

visitReadNonThisVariable

public void visitReadNonThisVariable(ReadVariableNode n,
                                     Value v)

Description copied from interface: IAnalysisMonitoring

Invoked when a non-this variable read operation cccurs.

Specified by:

visitReadNonThisVariable in interface IAnalysisMonitoring

Parameters:

n - (non-this) read variable operation

v - the value being read

visitReadProperty

public void visitReadProperty(ReadPropertyNode n,
                              java.util.Set<ObjectLabel> objlabels,
                              PKeys propertyname,
                              boolean maybe,
                              State state,
                              Value v,
                              ObjectLabel global_objv)

Description copied from interface: IAnalysisMonitoring

Invoked when a property read operation cccurs.

Specified by:

visitReadProperty in interface IAnalysisMonitoring

Parameters:

n - read property operation

objlabels - objects being read from

propertyname - description of the property name

maybe - if there may be more than one value

state - current abstract state

v - property value with attributes

global_objv - the global object

visitReadThis

public void visitReadThis(ReadVariableNode n,
                          Value v,
                          State state,
                          ObjectLabel global_obj)

Description copied from interface: IAnalysisMonitoring

Invoked when 'this' is read.

Specified by:

visitReadThis in interface IAnalysisMonitoring

Parameters:

n - (this) read variable operation

v - the value being read

state - current abstract state

visitReadVariable

public void visitReadVariable(ReadVariableNode n,
                              Value v,
                              State state)

Description copied from interface: IAnalysisMonitoring

Invoked when a variable read operation occurs. Variables named 'undefined' are ignored.

Specified by:

visitReadVariable in interface IAnalysisMonitoring

Parameters:

n - read variable operation

v - the value being read

visitRecoveryGraph

public void visitRecoveryGraph(AbstractNode node,
                               int size)

Description copied from interface: ILatticeMonitoring

Invoked when a recovery graph has been built.

Specified by:

visitRecoveryGraph in interface ILatticeMonitoring

visitRenameObject

public void visitRenameObject(AbstractNode node,
                              ObjectLabel from,
                              ObjectLabel to,
                              State s)

Description copied from interface: ILatticeMonitoring

Invoked when an abstract object changes name (from singleton to summary for recency abstraction).

Specified by:

visitRenameObject in interface ILatticeMonitoring

visitUnknownValueResolve

public void visitUnknownValueResolve(AbstractNode node,
                                     boolean partial,
                                     boolean scanning)

Description copied from interface: ILatticeMonitoring

Invoked when an unknown value is resolved.

Specified by:

visitUnknownValueResolve in interface ILatticeMonitoring

visitUserFunctionCall

public void visitUserFunctionCall(Function f,
                                  AbstractNode call,
                                  boolean constructor)

Description copied from interface: IAnalysisMonitoring

Invoked when a user-function call occurs.

Specified by:

visitUserFunctionCall in interface IAnalysisMonitoring

Parameters:

f - function being called

call - node responsible for the call

constructor - if set, the call uses 'new'

visitVariableAsRead

public void visitVariableAsRead(AbstractNode n,
                                java.lang.String varname,
                                Value v,
                                State state)

Description copied from interface: IAnalysisMonitoring

Invoked when a variable read operation occurs.

Specified by:

visitVariableAsRead in interface IAnalysisMonitoring

Parameters:

n - (non-this) read variable operation

varname - the name of the variable

v - value being read

visitVariableOrProperty

public void visitVariableOrProperty(AbstractNode node,
                                    java.lang.String var,
                                    SourceLocation loc,
                                    Value value,
                                    Context context,
                                    State state)

Description copied from interface: IAnalysisMonitoring

Invoked when a variable or property is read or written.

Specified by:

visitVariableOrProperty in interface IAnalysisMonitoring