Preface

Analyzing Program Performance with Sun WorkShop

Preface

This manual describes the performance and analysis tools available with Sun WorkShop^TM. Developing high performance applications requires a combination of compiler features, libraries of optimized routines, and tools to analyze and isolate code. Analyzing Program Performance With Sun WorkShop describes the third part of this development strategy, and shows you how to use these tools:

The Sampling Analyzer and Sampling Collector
LoopTool and LoopReport
prof, gprof, and tcov

Who Should Use This Book

This manual is intended for programmers with a working knowledge of Sun WorkShop and some understanding of the Solaris^TM operating environment and UNIX® commands. Some knowledge of performance analysis is also helpful in understanding how to use the data that is derived from the tools, but is not required for using the tools. The traditional profiling tools prof, gprof, and tcov do not require a working knowledge of Sun WorkShop.

Multiplatform Release

This Sun WorkShop release supports versions 2.6, 7, and 8 of the Solaris^TM SPARC^TM Platform Edition and Solaris Intel Platform Edition Operating Environments.

Note – The term "x86" refers to the Intel 8086 family of microprocessor chips, including the Pentium, Pentium Pro, and Pentium II processors and compatible microprocessor chips made by AMD and Cyrix. In this document, the term "x86" refers to the overall platform architecture, whereas "Intel Platform Edition" appears in the product name.

Access to Sun WorkShop Development Tools

Because Sun WorkShop product components and man pages do not install into the standard /usr/bin/ and /usr/share/man directories, you must change your PATH and MANPATH environment variables to enable access to Sun WorkShop compilers and tools.

To determine if you need to set your PATH environment variable:
1. Display the current value of the PATH variable by typing:

% echo $PATH
2. Review the output for a string of paths containing /opt/SUNWspro/bin/.

If you find the paths, your PATH variable is already set to access Sun WorkShop development tools. If you do not find the paths, set your PATH environment variable by following the instructions in this section.

To determine if you need to set your MANPATH environment variable:
1. Request the workshop man page by typing:

% man workshop
2. Review the output, if any.

If the workshop(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 this section for setting your MANPATH environment variable.
Note – The information in this section assumes that your Sun WorkShop 6 products were installed in the /opt directory. Contact your system administrator if your Sun WorkShop software is not installed in /opt.

The PATH and MANPATH variables should be set in your home .cshrc file if you are using the C shell or in your home .profile file if you are using the Bourne or Korn shells:

To use Sun WorkShop commands, add the following to your PATH variable:

/opt/SUNWspro/bin

To access Sun WorkShop man pages with the man command, add the following to your MANPATH variable:

/opt/SUNWspro/man

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 and MANPATH variables to access this release, see the Sun WorkShop 6 Installation Guide or your system administrator.

How This Book Is Organized

Chapter 1, "Overview of Performance Profiling and Analysis Tools," introduces the performance analysis tools, briefly discussing what they do and when to use them.

Chapter 2, "Tutorial: Using the Sampling Collector and Analyzer," is a tutorial demonstrating how to use the Sampling Collector and Analyzer to fine-tune the performance of three sample programs.

Chapter 3, "Sampling Collector Reference," describes how to use the Sampling Collector to collect information about program execution.

Chapter 4, "Sampling Analyzer Reference," describes how to use the Sampling Analyzer to fine-tune program performance.

Chapter 5, "er_print Reference," describes how to use the er_print utility.

Chapter 6, "Advanced Topics: Understanding the Sampling Analyzer and Its Data," discusses advanced issues involving the impact of optimization on data that is displayed by the Sampling Analyzer.

Chapter 7, "Loop Analysis Tools," presents LoopReport and LoopTool, which help you analyze program loops that have been parallelized by your compiler.

Appendix A, "Traditional Profiling Tools," covers the traditional profiling tools prof, gprof, and tcov. These tools help you find the parts of your program that are most heavily used, and determine how much of your program is being tested.

Typographic Conventions

TABLE P-1 shows the typographic conventions that are used in Sun WorkShop documentation.
TABLE P-1   Typographic Conventions Typeface Meaning Examples AaBbCc123 The names of commands, files, and directories; on-screen computer output Edit your .login file. Use ls -a to list all files. % You have mail. AaBbCc123 What you type, when contrasted with on-screen computer output % su Password: AaBbCc123 Book titles, new words or terms, words to be emphasized Read Chapter 6 in the User's Guide. These are called class options. You must be superuser to do this. AaBbCc123 Command-line placeholder text; replace with a real name or value To delete a file, type rm filename.

Shell Prompts

TABLE P-2 shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

TABLE P-2   Shell Prompts
Shell Prompt

C shell %

Bourne shell and Korn shell $

C shell, Bourne shell, and Korn shell superuser #

Related Documentation

You can access documentation related to the subject matter of this book in the following ways:

Through the Internet at the docs.sun.comsm Web site. You can search for a specific book title or you can browse by subject, document collection, or product at the following Web site:

http://docs.sun.com

Through the installed Sun WorkShop products on your local system or network. Sun WorkShop 6 HTML documents (manuals, online help, man pages, component readme files, and release notes) are available with your installed Sun WorkShop 6 products. To access the HTML documentation, do one of the following:

In any Sun WorkShop or Sun WorkShop^TM TeamWare window, choose Help About Documentation.
In your Netscape^TM Communicator 4.0 or compatible version browser, open the following file:

/opt/SUNWspro/docs/index.html

(Contact your system administrator if your Sun WorkShop software is not installed in the /opt directory.) Your browser displays an index of Sun WorkShop 6 HTML documents. To open a document in the index, click the document's title.

TABLE P-3 lists related Sun WorkShop 6 manuals by document collection.

TABLE P-3   Related Sun WorkShop 6 Documentation by Document Collection
Document Collection Document Title Description

Forte^TM Developer 6 / Sun WorkShop 6 Release Documents About Sun WorkShop 6 Documentation Describes the documentation available with this Sun WorkShop release and how to access it.

What's New in Sun WorkShop 6 Provides information about the new features in the current and previous release of Sun WorkShop.

Sun WorkShop 6 Release Notes Contains installation details and other information that was not available until immediately before the final release of Sun WorkShop 6. This document complements the information that is available in the component readme files.

Forte Developer 6 / Sun WorkShop 6
Debugging a Program With dbx Provides information on using dbx commands to debug a program with references to how the same debugging operations can be performed using the Sun WorkShop Debugging window.

Introduction to Sun WorkShop Acquaints you with the basic program development features of the Sun WorkShop integrated programming environment.

Forte^TM C 6 / Sun WorkShop 6 Compilers C C User's Guide Describes the C compiler options, Sun-specific capabilities such as pragmas, the lint tool, parallelization, migration to a 64-bit operating system, and ANSI/ISO-compliant C.

Forte^TM C++ 6 / Sun WorkShop 6 Compilers C++ C++ Library Reference Describes the C++ libraries, including C++ Standard Library, Tools.h++ class library, Sun WorkShop Memory Monitor, Iostream, and Complex.

C++ Migration Guide Provides guidance on migrating code to this version of the Sun WorkShop C++ compiler.

C++ Programming Guide Explains how to use the new features to write more efficient programs and covers templates, exception handling, runtime type identification, cast operations, performance, and multithreaded programs.

C++ User's Guide Provides information on command-line options and how to use the compiler.

Sun WorkShop Memory Monitor User's Manual Describes how the Sun WorkShop Memory Monitor solves the problems of memory management in C and C++. This manual is only available through your installed product (see /opt/SUNWspro/docs/index.html) and not at the docs.sun.com Web site.

Forte^TM for High Performance Computing 6 / Sun WorkShop 6 Compilers Fortran 77/95 Fortran Library Reference Provides details about the library routines supplied with the Fortran compiler.

Fortran Programming Guide Discusses issues relating to input/output, libraries, program analysis, debugging, and performance.

Fortran User's Guide Provides information on command-line options and how to use the compilers.

FORTRAN 77 Language Reference Provides a complete language reference.

Interval Arithmetic Programming Reference Describes the intrinsic INTERVAL data type supported by the Fortran 95 compiler.

Standard Library 2 Standard C++ Class Library Reference Provides details on the Standard C++ Library.

Standard C++ Library User's Guide Describes how to use the Standard C++ Library.

Tools.h++ 7 Tools.h++ User's Guide Discusses use of the C++ classes for enhancing the efficiency of your programs.

Tools.h++ Class Library Reference Provides details on the Tools.h++ class library.

TABLE P-4 describes related Solaris documentation available through the docs.sun.com Web site.

TABLE P-4   Related Solaris Documentation
Document Collection Document Title Description

Solaris Software Developer Linker and Libraries Guide Describes the operations of the Solaris link-editor and runtime linker and the objects on which they operate.

Programming Utilities Guide Provides information for developers about the special built-in programming tools that are available in the Solaris operating environment.

`%` `echo $PATH`

`%` `man workshop`

**TABLE P-1** Typographic Conventions
Typeface	Meaning	Examples
`AaBbCc123`	The names of commands, files, and directories; on-screen computer output	Edit your `.login` file. Use `ls -a` to list all files. `% You have mail`.
`AaBbCc123`	What you type, when contrasted with on-screen computer output	`%` `su` `Password:`
AaBbCc123	Book titles, new words or terms, words to be emphasized	Read Chapter 6 in the User's Guide. These are called class options. You must be superuser to do this.
AaBbCc123	Command-line placeholder text; replace with a real name or value	To delete a file, type `rm` filename.

**TABLE P-2** Shell Prompts
Shell	Prompt
C shell	`%`
Bourne shell and Korn shell	`$`
C shell, Bourne shell, and Korn shell superuser	`#`

**TABLE P-3** Related Sun WorkShop 6 Documentation by Document Collection
Document Collection	Document Title	Description
Forte^TM Developer 6 / Sun WorkShop 6 Release Documents	About Sun WorkShop 6 Documentation	Describes the documentation available with this Sun WorkShop release and how to access it.
	What's New in Sun WorkShop 6	Provides information about the new features in the current and previous release of Sun WorkShop.
	Sun WorkShop 6 Release Notes	Contains installation details and other information that was not available until immediately before the final release of Sun WorkShop 6. This document complements the information that is available in the component readme files.
Forte Developer 6 / Sun WorkShop 6	Debugging a Program With dbx	Provides information on using dbx commands to debug a program with references to how the same debugging operations can be performed using the Sun WorkShop Debugging window.
	Introduction to Sun WorkShop	Acquaints you with the basic program development features of the Sun WorkShop integrated programming environment.
Forte^TM C 6 / Sun WorkShop 6 Compilers C	C User's Guide	Describes the C compiler options, Sun-specific capabilities such as pragmas, the `lint` tool, parallelization, migration to a 64-bit operating system, and ANSI/ISO-compliant C.
Forte^TM C++ 6 / Sun WorkShop 6 Compilers C++	C++ Library Reference	Describes the C++ libraries, including C++ Standard Library, Tools.h++ class library, Sun WorkShop Memory Monitor, Iostream, and Complex.
	C++ Migration Guide	Provides guidance on migrating code to this version of the Sun WorkShop C++ compiler.
	C++ Programming Guide	Explains how to use the new features to write more efficient programs and covers templates, exception handling, runtime type identification, cast operations, performance, and multithreaded programs.
	C++ User's Guide	Provides information on command-line options and how to use the compiler.
	Sun WorkShop Memory Monitor User's Manual	Describes how the Sun WorkShop Memory Monitor solves the problems of memory management in C and C++. This manual is only available through your installed product (see `/opt/SUNWspro/docs/index.html`) and not at the `docs.sun.com` Web site.
Forte^TM for High Performance Computing 6 / Sun WorkShop 6 Compilers Fortran 77/95	Fortran Library Reference	Provides details about the library routines supplied with the Fortran compiler.
	Fortran Programming Guide	Discusses issues relating to input/output, libraries, program analysis, debugging, and performance.
	Fortran User's Guide	Provides information on command-line options and how to use the compilers.
	FORTRAN 77 Language Reference	Provides a complete language reference.
	Interval Arithmetic Programming Reference	Describes the intrinsic `INTERVAL` data type supported by the Fortran 95 compiler.
Standard Library 2	Standard C++ Class Library Reference	Provides details on the Standard C++ Library.
	Standard C++ Library User's Guide	Describes how to use the Standard C++ Library.
Tools.h++ 7	Tools.h++ User's Guide	Discusses use of the C++ classes for enhancing the efficiency of your programs.
	Tools.h++ Class Library Reference	Provides details on the `Tools.h++` class library.

**TABLE P-4** Related Solaris Documentation
Document Collection	Document Title	Description
Solaris Software Developer	Linker and Libraries Guide	Describes the operations of the Solaris link-editor and runtime linker and the objects on which they operate.
	Programming Utilities Guide	Provides information for developers about the special built-in programming tools that are available in the Solaris operating environment.

Library | Contents | Previous | Next | Index