Intel® Advisor Help
You can use the Intel® Advisor command line interface, advixe-cl, to run analysis and data collection. This makes it possible to automate many tasks or analyze an application running on remote hosts. The results can be viewed through the Intel Advisor GUI, or used to generate various kinds of reports.
Before using the command line, you must set command line environment variables. For instructions, see Setting Up Your Command Line Environment.
The advixe-cl command syntax is:
$ advixe-cl <-action> [-project-dir PATH] [-action-options] [-global-options] [[--] target [target options]]
advixe-cl |
The name of the Intel® Advisor command line tool. |
<-action> |
The action to perform, such as collect or report. Each command has exactly one action. For example, you cannot use both the collect and report actions in the same command. |
[-project-dir PATH] |
The directory where the project is stored. All result files will be created under this directory. |
[-action-option] |
Action-options modify behavior specific to the action. You can have multiple action-options per command. Using an action-option that does not apply to the action results in a usage error. |
[-global-option] |
Global-options modify behavior in the same manner for all actions. You can have multiple global-options per action. |
target |
The target executable (application) to analyze. |
[target-options] |
Options for the target. |
Search Directory
Use the search-dir option to specify which directories store the source, symbol and binary files that should be used during analysis. It is a good practice to always specify your search directories when using collect action to ensure that the source code annotations are found.
Multiple search directories can be specified, as in this example.
$ advixe-cl -collect survey -project-dir ./advi -search-dir src:=./src1,./src2 -- myApplication
Project Directory
By default, the project directory is your current working directory. When you want a result written to a different directory, use the project-dir option to specify the project directory you want.
This command surveys the application to determine hotspots, writing the result to the specified project directory.
$ advixe-cl -collect survey -project-dir ./advi -search-dir all:=./src -- myApplication
This example generates a Survey report from the hotspots survey result in the specified project directory.
$ advixe-cl -report survey -project-dir ./advi -format=text -report-output ./out/survey.txt
User Data Directory
Use the user-data-dir option when you want to write result files to a directory other than project-dir, which is the default. For example, if you want the result stored in a remote directory, or if there is not enough space in project-dir to hold the data collections.
This example collects Suitability data, storing the data collection results in the location specified by user-data-dir.
$ advixe-cl -collect suitability -project-dir ./advi -user-data-dir <PATH> -search-dir src:=./src -- myApplication
Enter advixe-cl -help to access all online help through the command line.
This help uses one dash before an option, but either one or two dashes can be used. These two help commands are equivalent:
The target executable must be preceded by two dashes and a space:
An option-value pair can be separated by an equal sign (=) or by a space. These two commands are equivalent:
Some action-options accept multiple arguments. The arguments can be passed in as a comma-separated string (with no spaces), or by repeating the action-option. These two commands are equivalent.