command

Perform the specified action on a running analysis.

GUI Equivalent

Toolbar: Command

Syntax

-command <value>

-C <value>

Note

Both short names and long names are case-sensitive. For example, -c is the short name of the collect action, and -C is the short name of the command action.

Arguments

Possible values are:

stop

Terminate target execution and collection for a threading or memory error analysis.

reset-leak-tracking

Reset the start point for finding memory leaks in the currently running memory error analysis. The default start point is the application start.

find-leaks

Search for new memory leaks since the currently running memory error analysis started (default) or since the last reset. View findings - in the form of zero, one, or more Memory leak problems - in the Problem report or GUI Problems pane. See Description section for prerequisites.

reset-growth-tracking

Reset the start point for measuring memory growth in the currently running memory error analysis. The default start point is the application start.

measure-growth

Measure memory growth since the currently running memory error analysis started (default) or since the last reset. View findings - in the form of one Memory growth problem - in the Problem report or GUI Problems pane. See Description section for prerequisites.

Default

The action is performed in the current working directory.

Description

Note

If you use the result-dir option to specify the result directory during analysis and data collection, you must use it when issuing these commands.

Use the command action to:

  • Terminate the currently running threading or memory error analysis.

  • Find memory leaks on demand in the currently running memory error analysis.

  • Measure memory growth in the currently running memory error analysis.

On-demand Memory Leak and Memory Growth Detection

Prerequisites: On-demand memory leak detection and memory growth detection commands are valid only for the mi2 or mi3 analysis types. The knobs that support on-demand memory leak detection and memory growth detection are enabled in these analysis types by default: enable-on-demand-leak-detection and enable-memory-growth-detection.

Use command with find-leaks and reset-leak-tracking to gather memory leak information while an application is running. This is useful if:

  • An application does not terminate (such as a server process).

  • You want memory leak information, but you do not want to wait for an application to terminate.

  • You want to determine if memory is leaked during a specific interval of application execution, or during a specific user action.

  • You want to discard information about allocations performed during initialization as a way of filtering out allocations that are not currently of interest.

Use command with measure-growth and reset-growth-tracking to ensure an application uses no more memory than expected. This includes:

  • Memory an application has allocated and still needs for future calculations

  • Memory an application has allocated and no longer needs, but has not deallocated

  • Memory an application has allocated and then leaked

For more precision, consider using these commands in tandem with APIs for custom memory allocation.

Examples

Terminate the analysis and data collection process that is currently running and storing the result in the myRes result directory.

$ inspxe-cl -command stop -result-dir myRes

After starting an analysis on the command line that is storing a result in the myRes result directory, measure memory growth from application start to this point. Note that the result directory used when starting the collection must be specified in all subsequent commands operating on that result. The command has no effect if myRes does not match a result directory for a currently running collection.

$ inspxe-cl -command measure-growth -result-dir myRes
For more complete information about compiler optimizations, see our Optimization Notice.