dk.brics.tajs.monitoring

Class Monitoring

java.lang.Object

dk.brics.tajs.monitoring.Monitoring

All Implemented Interfaces:

ILatticeMonitoring, IAnalysisMonitoring, ISolverMonitoring<State,Context>

public class Monitoring
extends java.lang.Object
implements IAnalysisMonitoring

Records various information during analysis.

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.
java.util.Set<Message>	getMessages() Returns the collected messages.
java.util.List<Message>	getSortedMessages() Returns the sorted list of messages produced during scanning.
java.util.Map<TypeCollector.VariableSummary,Value>	getTypeInformation() Returns the collected type information.
static IAnalysisMonitoring	make()
static IAnalysisMonitoring	make(boolean allow_progress_monitor) Constructs a new monitoring object.
void	setSolverInterface(GenericSolver.SolverInterface c) Sets the solver interface which will be used by the analysis.
void	visitBlockTransferPost(BasicBlock b, State state) Ignored.
void	visitBlockTransferPre(BasicBlock block, State state) Counts block transfers.
void	visitCall(AbstractNode n, Value funval) Checks for call/construct to a non-function value causing a TypeError.
void	visitEvalCall(AbstractNode n, Value v) Registers a call to eval.
void	visitEventHandlerRegistration(AbstractNode node, Context context, Value handler) Ignored.
void	visitFunction(Function f, java.util.Collection<State> entry_states) Registers reachability information.
void	visitIf(IfNode n, Value v) Checks whether the branch condition is always true or always false.
void	visitIn(AbstractNode n, boolean maybe_v2_object, boolean maybe_v2_nonobject) Checks whether the 'in' operation may fail with a TypeError.
void	visitInnerHTMLWrite(Node n, Value v) Registers a write to innerHTML.
void	visitInstanceof(AbstractNode n, boolean maybe_v2_non_function, boolean maybe_v2_function, boolean maybe_v2_prototype_primitive, boolean maybe_v2_prototype_nonprimitive) Checks whether the 'instanceof' operation may fail with a TypeError.
void	visitIterationDone(java.lang.String terminatedEarlyMsg) Ignored.
void	visitJoin(long ms) Counts state join operations and their time.
void	visitNativeFunctionCall(AbstractNode n, HostObject hostobject, boolean num_actuals_unknown, int num_actuals, int min, int max) Checks the number of parameters for a call to a native function.
void	visitNativeFunctionReturn(AbstractNode node, HostObject hostObject, Value result) Ignored.
void	visitNewFlow(BasicBlock b, Context c, State s, java.lang.String diff, java.lang.String info) Collects new dataflow (if enabled).
void	visitNewObject(AbstractNode node, ObjectLabel label, State s) Ignored.
void	visitNodeTransferPost(AbstractNode n, State s) Ignored.
void	visitNodeTransferPre(AbstractNode n, State s) Counts node transfers and registers reachability information.
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) Ignored.
void	visitPropagationPre(BlockAndContext<Context> from, BlockAndContext<Context> to) Ignored.
void	visitPropertyAccess(Node n, Value baseval) Checks whether the property access operation may dereference null or undefined causing a TypeError.
void	visitPropertyRead(AbstractNode n, java.util.Set<ObjectLabel> objs, PKeys propertyname, State state, boolean check_unknown) Checks for reads from unknown properties; also registers a read operation on abstract objects.
void	visitPropertyWrite(Node n, java.util.Set<ObjectLabel> objs, PKeys propertyname) Checks for writes to unknown properties; also registers a write operation on abstract objects.
void	visitRead(Node n, Value v, State state) Registers type information about a var/prop read.
void	visitReadNonThisVariable(ReadVariableNode n, Value v) Checks whether an absent variable is read.
void	visitReadProperty(ReadPropertyNode n, java.util.Set<ObjectLabel> objlabels, PKeys propertyname, boolean maybe, State state, Value v, ObjectLabel global_obj) Checks whether the property read operation accesses an absent property and whether the operation returns null/undefined.
void	visitReadThis(ReadVariableNode n, Value v, State state, ObjectLabel global_obj) Checks whether the read of 'this' yields the global object or an imprecise value.
void	visitReadVariable(ReadVariableNode n, Value v, State state) Checks whether the variable read yields null/undefined.
void	visitRecoveryGraph(AbstractNode node, int size) Registers the recovery graph size.
void	visitRenameObject(AbstractNode node, ObjectLabel from, ObjectLabel to, State s) Ignored.
void	visitUnknownValueResolve(AbstractNode node, boolean partial, boolean scanning) Counts unknown-value-resolve operations.
void	visitUserFunctionCall(Function f, AbstractNode call, boolean constructor) Checks whether the function is invoked both as a constructor (with 'new') and as a function/method (without 'new').
void	visitVariableAsRead(AbstractNode n, java.lang.String varname, Value v, State state) Registers that the given variable is read; also checks for suspicious type mixings.
void	visitVariableOrProperty(AbstractNode node, java.lang.String var, SourceLocation loc, Value value, Context context, State state) Registers the name, location, and value of a variable or property being read or written.

Methods inherited from class java.lang.Object

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

Method Detail

addMessage

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

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)

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)

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>

getMessages

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

Returns the collected messages.

Specified by:

getMessages in interface IAnalysisMonitoring

getSortedMessages

public java.util.List<Message> getSortedMessages()

Returns the sorted list of messages produced during scanning. Ignores those messages that have Severity.MEDIUM_IF_CERTAIN_NONE_OTHERWISE if not Status.CERTAIN and those that have Severity.LOW if not the option low-severity is enabled.

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

make

public static IAnalysisMonitoring make()

make

public static IAnalysisMonitoring make(boolean allow_progress_monitor)

Constructs a new monitoring object.

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 state)

Ignored.

Specified by:

visitBlockTransferPost in interface ISolverMonitoring<State,Context>

visitBlockTransferPre

public void visitBlockTransferPre(BasicBlock block,
                                  State state)

Counts block transfers.

Specified by:

visitBlockTransferPre in interface ISolverMonitoring<State,Context>

visitCall

public void visitCall(AbstractNode n,
                      Value funval)

Checks for call/construct to a non-function value causing a TypeError. Also checks for suspiciously imprecise function values.

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)

Registers a call to eval.

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)

Ignored.

Specified by:

visitEventHandlerRegistration in interface IAnalysisMonitoring

visitFunction

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

Registers reachability information.

Specified by:

visitFunction in interface ISolverMonitoring<State,Context>

visitIf

public void visitIf(IfNode n,
                    Value v)

Checks whether the branch condition is always true or always false.

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)

Checks whether the 'in' operation may fail with a TypeError.

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)

Registers a write to innerHTML.

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)

Checks whether the 'instanceof' operation may fail with a TypeError.

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)

Ignored.

Specified by:

visitIterationDone in interface ISolverMonitoring<State,Context>

Parameters:

terminatedEarlyMsg - message about premature termination, if non-null

visitJoin

public void visitJoin(long ms)

Counts state join operations and their time.

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)

Checks the number of parameters for a call to a native function.

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)

Ignored.

Specified by:

visitNativeFunctionReturn in interface IAnalysisMonitoring

visitNewFlow

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

Collects new dataflow (if enabled).

Specified by:

visitNewFlow in interface ISolverMonitoring<State,Context>

visitNewObject

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

Ignored.

Specified by:

visitNewObject in interface ILatticeMonitoring

visitNodeTransferPost

public void visitNodeTransferPost(AbstractNode n,
                                  State s)

Ignored.

Specified by:

visitNodeTransferPost in interface ISolverMonitoring<State,Context>

visitNodeTransferPre

public void visitNodeTransferPre(AbstractNode n,
                                 State s)

Counts node transfers and registers reachability information.

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)

Ignored.

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)

Ignored.

Specified by:

visitPropagationPre in interface ISolverMonitoring<State,Context>

visitPropertyAccess

public void visitPropertyAccess(Node n,
                                Value baseval)

Checks whether the property access operation may dereference null or undefined causing a TypeError.

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)

Checks for reads from unknown properties; also registers a read operation on abstract objects. Properties named 'length' on array objects are ignored.

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)

Checks for writes to unknown properties; also registers a write operation on abstract objects. Properties named 'length' on array objects are ignored. Writes to the arguments object are also ignored.

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)

Registers type information about a var/prop read.

Specified by:

visitRead in interface IAnalysisMonitoring

visitReadNonThisVariable

public void visitReadNonThisVariable(ReadVariableNode n,
                                     Value v)

Checks whether an absent variable is read.

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_obj)

Checks whether the property read operation accesses an absent property and whether the operation returns null/undefined.

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_obj - the global object

visitReadThis

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

Checks whether the read of 'this' yields the global object or an imprecise value.

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)

Checks whether the variable read yields null/undefined. 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)

Registers the recovery graph size.

Specified by:

visitRecoveryGraph in interface ILatticeMonitoring

visitRenameObject

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

Ignored.

Specified by:

visitRenameObject in interface ILatticeMonitoring

visitUnknownValueResolve

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

Counts unknown-value-resolve operations.

Specified by:

visitUnknownValueResolve in interface ILatticeMonitoring

visitUserFunctionCall

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

Checks whether the function is invoked both as a constructor (with 'new') and as a function/method (without 'new').

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)

Registers that the given variable is read; also checks for suspicious type mixings.

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)

Registers the name, location, and value of a variable or property being read or written. Also checks for suspiciously imprecise values.

Specified by:

visitVariableOrProperty in interface IAnalysisMonitoring