            ------------------------------------------------------
                                 pfmon-3.0:
	         a tool to monitor performance on Linux/ia64
            ------------------------------------------------------
	        Copyright (c) 2001-2003 Hewlett-Packard Company
	            Stephane Eranian <eranian@hpl.hp.com>

This package provides a tool, called pfmon, which monitors performance
on unmodified binaries or for the entire system. It is using the IA-64 
Performance Monitoring Unit (PMU). This package uses the Linux/ia64 
kernel support for the PMU (perfmon) and the libpfm library.

This version of pfmon supports BOTH the Itanium (Merced) and Itanium2 
(McKinley, Madison, Deerfield, DP) processors.

REQUIREMENTS
------------

         - YOU MUST at least HAVE  kernel 2.6.0-test5 or higher. This version 
	   of pfmon DOES NOT work on ANY 2.4-based kernels, that includes 
	   RHEL-3.0 and SLES8 kernels.

	 - you need libpfm-3.0. It is available from:
	   http://www.hpl.hp.com/research/linux/perfmon/ 

	 - to recompile pfmon you need the libelf development package or 
	   equivalent such as elfutils-devel on RHEL-3.0.

	 - if you want pfmon crash dump support you need to download libunwind.
	   You can download this library from the following site: 
	   http://www.hpl.hp.com/research/linux/libunwind

WHAT'S THERE
-------------

	- the pfmon tool (pfmon directory) which collects performance data on 
	  unmodified binaries or for the entire system (UP & SMP).

	- a small set of test programs (tests directory) including pfdbg to 
	  turn on/off kernel perfmon debugging. 

	- a simple script (scripts directory) to collect a cycle breakdown 
	  using pfmon on Itanium (not Itanium2).

	- a user's guide (docs directory) for pfmon for both Itanium and 
	  Itanium2.

INSTALLATION
------------

	- you must have the libpfm package already installed 
	 (the runtime package at a minimum).

	- edit config.mk to :
	  - update some config variables to suit your installation
	  - if you have libunwind and want call stack dumping on pfmon crash,
	    say 'y' for CONFIG_PFMON_LIBUNWIND
	  - select your compiler options
	  - select which PMU you want to support. Multiple PMUs can be 
	    supported by a single binary

	- type make
	- type make install
	- you're done, type pfmon --help for a list of options

DOCUMENTATION
-------------

	- extensive documentation with examples is available in the docs 
	  subdirectory

	- More up to date information can be found on pfmon web site: 
	  http://www.hpl.hp.com/research/linux/perfmon
