United States-English

HP Caliper User Guide: Release 4.4 February 2008

»

Technical documentation


	Complete book in PDF


»	Feedback

» Table of Contents

» Glossary

» Index

HP Part Number: 5992-3827

Edition: 4.4

Published: February 2008

© Copyright 2008 Hewlett-Packard Development Company, L.P.

Table of Contents

About This Document

1 HP Caliper at a Glance

What Is HP Caliper?

What Does HP Caliper Run On?

Supported Hardware and Operating Systems
Supported Compilers and Application Environments

Summary of HP Caliper Features

2 Getting Started with the HP Caliper Command-Line Interface

Example: Running fprof on a Short Program, with Default Output

Example: Adding Instructions to an fprof Report

Types of Measurements

Global Measurement
Sampled Measurements
Precise Measurements

What to Look for in Using HP Caliper

Syntax for caliper Command

Basic Tasks: A Quick Reference

Starting HP Caliper
Stopping HP Caliper
Showing HP Caliper Options
Creating a Call Graph Profile with HP Caliper
Creating a Text Report for Analysis
Creating a Report Based on Your Collected Data

Using the HP Caliper Advisor

Restrictions on Using HP Caliper

Additional HP Caliper Commands

Getting Information About HP Caliper

3 Getting Started with the HP Caliper GUI

What Is the HP Caliper GUI?

Window Basics

Projects View
Collect View
Analyze View
Advisor View
Console View
Diagnostics View
Help View
Tips for Using Views

Making Measurements

Hints on How to Make Measurements

Exploring Performance Data

Getting Performance Tuning Advice

Getting Help

Starting the GUI

Native (Local) GUI
Remote GUI

4 HP Caliper Measurement Configuration Files

Measurement Configuration Files Provided with HP Caliper

Location of Measurement Configuration Files

Specifying Option Values in Measurement Configuration Files
Using the Command Line to Override Measurement Configuration File Parameters

5 HP Caliper Options

Basic Information About Options

Multiple Ways to Specify HP Caliper Option Values
Hierarchy for Processing an Option Value

-d or --database

-e or --duration

-f or --options-file

-H or --help

-m or --metrics

-m cpu_event
-m event_set

-o or --output-file

-p or --process

-r or --report-details

-r for PMU Histogram Reports
-r for Function Coverage Reports

-s or --sampling-spec

-v or --version

--advice-classes

--advice-cutoff

--advice-details

--analysis-focus

--branch-sampling-spec

--bus-speed

--callpath-cutoff

--context-lines

--cpu-aggregation

--cpu-counter

--cpu-details

Examples

--data-summary

--description-details

--detail-cutoff

Example

--etb-freeze-delay

Example

--etb-walkback-cycles

--event-defaults

Example

--exclude-caliper

--exclude-idle

--frame-depth

--kernel-path

--latency-buckets

--measure-on-interrupts

--memory-usage=

--module-default

--module-exclude

--module-include

--module-search-path

--noinlines

--options-file

--output-file

--overflow-block

--per-module-data

--percent-columns

--prim-cutoff

--process-cutoff

Example

--read-init-file

--report-details

--rule-files

--sampling-spec

Using --scope system for System-Wide Measurements

--skip-functions

--source-path-map

--summary-cutoff

--system-model (Linux only)

--system-usage=

--term-display

--traps-reported

--user-regions

6 Using the HP Caliper Advisor

What Is the HP Caliper Advisor?

Example of an HP Caliper Advisor Report

Steps in Using the Advisor

Command Line to Invoke the Advisor

Getting Started with the Advisor: Examples

Simplest Example
More Typical Examples
Explanation of Report Output

How to Read an Advisor Report

Suggestions for Using the HP Caliper Advisor

How the HP Caliper Advisor Works

7 Using the HP Caliper Advisor in the GUI

Basic Steps in Using the HP Caliper Advisor in the GUI
Making Performance Measurement Runs
Selecting Performance Data to Analyze [Optional]
Generating Advice
Reviewing and Acting on the Advice

8 Configuring HP Caliper

Specifying Option Values with a .caliperinit Initialization File

Example of a .caliperinit File
Setting Constants in the .caliperinit File

Configuring Data Collection

Specifying Which CPU Events to Measure
Specifying Which Load Modules to Collect Data For
Controlling Granularity of Data Collection and Reports
Specifying Processes to Measure
Using HP Caliper in Your Build Process
Attaching to a Running Process to Perform Measurements

How to Display Reference Information About CPU Counters or HP Caliper Report Types

Options for the caliper info Command
Examples of the caliper info Command

HP Caliper Environment Variables

9 Controlling the Content of Reports

Layout of an HP Caliper Text or CSV Report

Metrics You Can Use for Report Sorting and Cutoffs

Module-Centric Reports

Process Summary

Function Details

Disassembly Listing

Branch Targets in Disassembly Listings

Source Position Correlation

Source Line Data

Address Types Shown

How Functions Are Named in Reports

Unnamed Functions
Unknown Functions

VSE Information Shown in Report Output

HyperThreading Information for Dual-Core Itanium 2 Processors Shown in Report Output

How HP Caliper Saves Data in Databases

Names and Locations for the Databases

Creating Reports from Multiple Databases

Using the caliper report Command to Create a Report from One or More Databases
Using the caliper merge Command to Merge Data From Multiple Collection Runs
Using the caliper diff Command to Difference Data Collected in Two Databases

10 Producing a Sampled Call Graph Profile Analysis

How Sampled Call Graph Profile Analysis Works

Differences Between scgprof and cgprof

Running the HP Caliper Sampled Call Graph Profile

Sampled Call Graph Text Report Example

Sampled Call Graph Profile Report Details

Flat Profile Part of the Report
Call Graph Part of the Report
Hot Call Paths Part of the Report
Function Indexes
Diagnostic Messages

gprof Fallacy and Possibly Misleading Results

11 Producing a Sampled Call Stack Profile Analysis

Running HP Caliper to Produce a Call Stack Profile

Call Stack Profile Text Report Example for HP-UX

Call Stack Profile Text Report Example for Linux

Call Stack Profile Report Details

Flat Profile Part of the Report
Blocking Primitives Summary Part of the Report
Hot Call Paths Part of the Report
Call Graph Part of the Report
Function Indexes

Avoids gprof Fallacy

Limitations to Using cstack

12 Performing CPU Metrics Analysis

13 HP Caliper Features Specific to HP-UX

Measuring Memory Usage Concurrently with Other Measurements

Examples of the --memory-usage= Option
Example Report Output
How to Read the Reports

Measuring System Usage Concurrently with Other Measurements

Example Report Output
Interpreting the Data

Attaching to a Running Process to Perform Precise Measurements

Taking PMU Samples in Your Code

Triggering PMU Samples in Specific Code Regions
Restricting PMU Measurements to Specific Code Regions

A HP Caliper Diagnostic and Warning Messages

ERROR #28: Caliper Invalid Measurement Combination
Instructions Labeled STUB
Mispredicted Branches
PMU Sample Hits Outside Function Range
scgprof Reports Require Kernel Patch

B Descriptions of Measurement Reports

alat Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
alat Metrics Summed for Entire Run
alat Measurement Report Metrics
How ALAT Metrics Are Obtained

branch Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
branch Metrics Summed for Entire Run
branch Measurement Report Metrics
How branch Metrics Are Obtained

cgprof Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
HP Caliper Call Graph Profile Results Accuracy
Call Graph Profile Metrics

cpu Measurement Report Description

Example Command Lines for Text Report
Example Command Line for CSV Report
CPU Event Sets

cstack Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
cstack Measurement Report Metrics

cycles Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
cycles Metrics Summed for Entire Run
cycles Measurement Metrics
How cycles Metrics Are Obtained

dcache Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
dcache Metrics Summed for Entire Run
dcache Measurement Report Metrics
Example dcache Reports
Using the --data-summary Option to Produce a Data Summary
How Data Cache Metrics Are Obtained

dtlb Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
dtlb Metrics Summed for Entire Run
dtlb Measurement Report Metrics
How Data TLB Metrics Are Obtained

ecount Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
ecount Metrics Summed for Entire Run

fcount Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
fcount Measurement Report Metrics

fcover Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
fcover Measurement Report Metrics
Unknown Source Files
-r for Function Coverage Reports

fprof Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
fprof Metrics Summed for Entire Run
fprof Measurement Metrics
How fprof Metrics Are Obtained

icache Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
icache Metrics Summed for Entire Run
icache Measurement Report Metrics
Function Details
How Instruction Cache Metrics Are Obtained

itlb Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
itlb Metrics Summed for Entire Run
itlb Measurement Report Metrics
Function Details
How Instruction TLB Metrics Are Obtained

pmu_trace Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report

scgprof Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
scgprof Measurement Report Metrics (Flat Profile)
scgprof Measurement Report Metrics (Call Graph Profile)

traps Measurement Report Description

Example Command Line for Text Report
Example Command Line for CSV Report
traps Metrics Summed for Entire Run
traps Measurement Metrics
How traps Metrics Are Obtained

C Event Set Descriptions for CPU Metrics

brpath Event Set

Metrics Available from this Measurement

brpred Event Set

Metrics Available from this Measurement

c2c Event Set

Metrics Available from this Measurement

cpi Event Set

Metrics Available from this Measurement

cpubus Event Set

Metrics Available from this Measurement

cspec Event Set

Metrics Available from this Measurement

dispersal Event Set

Metrics Available from this Measurement

dspec Event Set

Metrics Available from this Measurement

fp Event Set

Correspondence Between Floating-Point Instructions and Operations
Metrics Available from this Measurement

l1dcache Event Set

Metrics Available from this Measurement

l1icache Event Set

Metrics Available from this Measurement

l2cache Event Set

Metrics Available from this Measurement

l2dcache Event Set

Metrics Available from this Measurement

l2icache Event Set

Metrics Available from this Measurement

l3cache Event Set

Metrics Available from this Measurement

queues Event Set

Metrics Available from this Measurement

stall Event Set

Metrics Available from this Measurement

sysbus Event Set

Metrics Available from this Measurement

threadswitch Event Set

Metrics Available from this Measurement

tlb Event Set

Metrics Available from this Measurement

List of Figures

1-1 HP Caliper Components (User Interfaces)
2-1 fprof Measurement Report for matmul, with Default Report Output
2-2 fprof Measurement Report for matmul, with IP Sample Counts for One Function
3-1 HP Caliper GUI
3-2 Projects View
3-3 Collect View
3-4 Analyze View
3-5 Advisor View
3-6 Console View
3-7 Diagnostics View
3-8 Help View
3-9 Login Screen
6-1 Steps in Using the Advisor
6-2 HP Caliper Advisor Report, with Annotations
7-1 HP Caliper GUI
7-2 Projects View, with a Single Project Selected
7-3 Projects View, with a Single Measurement Run Selected
7-4 HP Caliper GUI Toolbar
7-5 HP Caliper GUI Advisor Menu
7-6 Advisor Report in the HP Caliper GUI
8-1 .caliperinit File
8-2 Example of a Process Tree Report
8-3 Example Output of the caliper info Command
9-1 Disassembly Listing Example
10-1 Sampled Call Graph Text Report Example
11-1 Call Stack Profile Text Report Example
11-2 Call Stack Profile Text Report Example for Linux
13-1 Example Memory Usage Report Output for an SMP System
13-2 Example System Usage Report Output
13-3 Using Macros to Trigger PMU Samples
13-4 Example of PMU Trace Report
13-5 Restricting PMU Measurement to Specific Code
A-1 Mispredicted Branches Example
A-2 Comments in the branch Measurement Configuration File

List of Tables

4-1 Available Measurements in Each Measurement Type
8-1 Command-Line and Measurement Configuration File Syntax for -p Option
8-2 Action Options Used with -p some
8-3 Pattern String Interpretation Options Used with -p some
8-4 Name Source Options Used with -p some
8-5 Process Origin Options Used with -p some
9-1 Information in HP Caliper Reports Specific to Particular Types of Reports
9-2 Available Metrics for Report Sorting and Cutoffs
B-1 Information in alat Measurement Reports
B-2 Information in branch Measurement Reports
B-3 Information in cgprof Measurement Report Fields (Flat Profile)
B-4 Information in cgprof Measurement Report: Function Entries (Self Entries)
B-5 Information in cgprof Measurement Report: (Hot Call Paths Profile)
B-6 Information in cgprof Measurement Report: Parent Listings
B-7 Information in cgprof Measurement Report: Children Listings
B-8 Information in cstack Measurement Report Fields (Flat Profile)
B-9 Information in cstack Measurement Report Fields (Blocking Primitives Profile)
B-10 Information in cstack Measurement Report Fields (Hot Call Paths Profile)
B-11 Information in cstack Measurement Report Fields (Call Graph Profile)
B-12 Information in cycles Measurement Reports
B-13 Information in dcache Measurement Reports
B-14 Information in dtlb Measurement Reports
B-15 Information in fcount Measurement Reports
B-16 Information in fcover Measurement Reports
B-17 Information in Per-Source-File fcover Measurement Reports
B-18 Information in fprof Measurement Reports
B-19 Information in icache Measurement Reports
B-20 Information in itlb Measurement Reports
B-21 Information in scgprof Measurement Report Fields (Flat Profile)
B-22 Information in scgprof Measurement Report: Function Entries (Self Entries)
B-23 Information in scgprof Measurement Report (Hot Call Paths Profile)
B-24 Information in scgprof Measurement Report: Parent Listings
B-25 Information in scgprof Measurement Report: Children Listings
B-26 Information in traps Measurement Reports

List of Examples

6-1 HP Caliper Advisor Report
9-1 Example of a caliper merge Run
9-2 Example of a caliper diff Run
B-1 Example of a dcache Report for an rx4640 Integrity server
B-2 Example of a dcache Report for a Superdome Integrity Server

Printable version


Privacy statement	Using this site means you accept its terms	Feedback to webmaster

© 2008 Hewlett-Packard Development Company, L.P.