Before You Begin
This manual describes the performance analysis tools in the Sun Studio 10 software.
This manual is intended for application developers with a working knowledge of Fortran, C, C++, or the Java programming language; and some understanding of the Solaris Operating System (Solaris OS), or the Linux operating system, and UNIX® operating system commands. Some knowledge of performance analysis is helpful but is not required to use the tools.
Chapter 1 introduces the performance analysis tools, briefly discussing what they do and when to use them.
Chapter 2 describes the data collected by the Collector and how the data is converted into metrics of performance.
Chapter 3 describes how to use the Collector to collect timing data, synchronization delay data, and hardware event data from your program.
Chapter 4 describes how to start the Performance Analyzer and how to use the tool to analyze performance data collected by the Collector.
Chapter 5 describes how to use the er_print command line interface to analyze the data collected by the Collector.
Chapter 6 describes the process of converting the data collected by the Collector into performance metrics and how the metrics are related to program structure.
Chapter 7 describes how to use and understand the information in the source and disassembly windows of the Performance Analyzer.
Chapter 8 presents information on the utilities that are provided for manipulating and converting performance experiments and viewing annotated source code and disassembly code without running an experiment.
Appendix A describes the UNIX profiling tools prof, gprof, and tcov. These tools provide timing information and execution frequency statistics.
This Sun Studio release supports systems that use the SPARC® and x86 families of processor architectures: UltraSPARC®, SPARC64, AMD64, Pentium, and Xeon EM64T. The supported systems for the version of the Solaris Operating System you are running are available in the hardware compatibility lists at http://www.sun.com/bigadmin/hcl. These documents cite any implementation differences between the platform types.
In this document, the term "x86" refers to 64-bit and 32-bit systems manufactured using processors compatible with the AMD64 or Intel Xeon/Pentium product families. For supported systems, see the hardware compatibility lists.
The compilers and tools and their man pages are not installed into the standard /usr/bin/ and /usr/share/man directories. To access the compilers and tools, you must have your PATH environment variable set correctly (see Accessing the Compilers and Tools). To access the man pages, you must have the your MANPATH environment variable set correctly (see Accessing the Man Pages.).
For more information about the PATH variable, see the csh(1), sh(1), and ksh(1) man pages. For more information about the MANPATH variable, see the man(1) man page. For more information about setting your PATH variable and MANPATH variables to access this release, see the installation guide or your system administrator.
Note - The information in this section assumes that your Sun Studio compilers and tools are installed in the /opt directory on Solaris platforms and in the /opt/sun directory on Linux platforms. If your software is not installed in the /opt directory on Solaris platforms and in the default directory, ask your system administrator for the equivalent path on your system.
Use the steps below to determine whether you need to change your PATH variable to access the compilers and tools.
1. Display the current value of the PATH variable by typing the following at a command prompt.
2. On Solaris platforms, review the output to find a string of paths that contain /opt/SUNWspro/bin/. On Linux platforms, review the output to find a string of paths that contain /opt/sun/sunstudio10/bin.
If you find the path, your PATH variable is already set to access the compilers and tools. If you do not find the path, set your PATH environment variable by following the instructions in the next procedure.
1. If you are using the C shell, edit your home .cshrc file. If you are using the Bourne shell or Korn shell, edit your home .profile file.
2. On Solaris platforms, add the following to your PATH environment variable. If you have Forte Developer software, Sun ONE Studio software, or another release of Sun Studio software installed, add the following path before the paths to those installations:
On Linux platforms, add the following to your PATH environment variable:
Use the following steps to determine whether you need to change your MANPATH variable to access the man pages.
1. Request the collect man page by typing the following at a command prompt.
2. Review the output, if any.
If the collect(1) man page cannot be found or if the man page displayed is not for the current version of the software installed, follow the instructions in the next procedure for setting your MANPATH environment variable.
On Solaris platforms, add the following to your MANPATH environment variable:
On Linux platforms, add the following to your MANPATH environment variable:
The Sun Studio integrated development environment (IDE) provides modules for creating, editing, building, debugging, and analyzing the performance of a C, C++, Java, or Fortran application.
The command to start the IDE is sunstudio. For details on this command, see the sunstudio(1) man page.
The correct operation of the IDE depends on the IDE being able to find the core platform. The sunstudio command looks for the core platform in two locations:
If the core platform is not installed or mounted to either of the locations where the sunstudio command looks for it, then each user on a client system must set the environment variable SPRO_NETBEANS_HOME to the location where the core platform is installed or mounted (/installation_directory/netbeans/3.5V).
On Solaris platforms, each user of the IDE also must add /installation_directory/SUNWspro/bin to their $PATH in front of the path to any other release of Forte Developer software, Sun ONE Studio software or Sun Studio software.
On Linux platforms, each user of the IDE also must add /installation_directory/sunstudio10/bin to their $PATH in front of the path to any other release of Sun Studio software.
The path /installation_directory/netbeans/3.5V/bin should not be added to the user's $PATH.
You can access the documentation at the following locations:
If your software is not installed in the /opt directory on a Solaris platform or the /opt/sun directory on a Linux platform, ask your system administrator for the equivalent path on your system.
The docs.sun.com web site (http://docs.sun.com) enables you to read, print, and buy Sun Microsystems manuals through the Internet. If you cannot find a manual, see the documentation index that is installed with the software on your local system or network.
Note - Sun is not responsible for the availability of third-party Web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused by or in connection with the use of or reliance on any such content, goods, or services that are available on or through such sites or resources.
The documentation is provided in accessible formats that are readable by assistive technologies for users with disabilities. You can find accessible versions of documentation as described in the following table. If your software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.
HTML at http://docs.sun.com
HTML at http://docs.sun.com
For Solaris platforms, the following table describes related documentation that is available at /opt/SUNWspro/docs/index.html and at http://docs.sun.com . If your software is not installed in the /opt directory, ask your system administrator for the equivalent path on your system.
For Linux platforms, the following table describes related documentation that is available at file:/opt/sun/sunstudio10/docs/index.html at http://docs.sun.com. If your software is not installed in the /opt/sun directory, ask your system administrator for the equivalent path on your system.
The following table describes related documentation that is available through the docs.sun.com web site.
Visit http://developers.sun.com/prodtech/cc to find these frequently updated resources:
You can find additional resources for developers at http://developers.sun.com.
If you have technical questions about this product that are not answered in this document, go to:
Sun is interested in improving its documentation and welcomes your comments and suggestions. Submit your comments to Sun at this URL
Please include the part number (819-0493-11) of your document.