|
Packit |
577717 |
PAPI: Performance Application Programming Interface
|
|
Packit |
577717 |
===================================================
|
|
Packit |
577717 |
|
|
Packit |
577717 |
** Innovative Computing Lab **
|
|
Packit |
577717 |
|
|
Packit |
577717 |
** University of Tennessee, Knoxville, TN **
|
|
Packit |
577717 |
|
|
Packit |
577717 |
***
|
|
Packit |
577717 |
[TOC]
|
|
Packit |
577717 |
***
|
|
Packit |
577717 |
|
|
Packit |
577717 |
About
|
|
Packit |
577717 |
-----
|
|
Packit |
577717 |
|
|
Packit |
577717 |
PAPI provides the tool designer and application engineer with a
|
|
Packit |
577717 |
consistent interface and methodology for use of the performance
|
|
Packit |
577717 |
counter hardware found in most major microprocessors. PAPI enables
|
|
Packit |
577717 |
software engineers to see, in near real time, the relation between
|
|
Packit |
577717 |
software performance and processor events.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
In addition, PAPI provides access to a collection of components that
|
|
Packit |
577717 |
expose performance measurement opportunites across the hardware and
|
|
Packit |
577717 |
software stack.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
|
|
Packit |
577717 |
Getting Started
|
|
Packit |
577717 |
---------------
|
|
Packit |
577717 |
|
|
Packit |
577717 |
If this is the first file you've opened in the PAPI tree, we'll try to give you
|
|
Packit |
577717 |
a few tips on where to go from here.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
* Read the license found in LICENSE.txt. It's pretty short, and not very
|
|
Packit |
577717 |
restrictive, but it'll give you an idea of what you can and can't do with the
|
|
Packit |
577717 |
PAPI sources.
|
|
Packit |
577717 |
* Visit the website at: <http://icl.utk.edu/papi>
|
|
Packit |
577717 |
There you can find late-breaking news that may be more current than in these
|
|
Packit |
577717 |
files. You can also find documentation in a greater variety of formats than
|
|
Packit |
577717 |
in the papi/doc/ directory.
|
|
Packit |
577717 |
* Sign up for the PAPI mailing list(s). Instructions are on our home page.
|
|
Packit |
577717 |
* Read the RELEASENOTES.txt file to get an idea of what's new in the current release.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
|
|
Packit |
577717 |
Installing PAPI
|
|
Packit |
577717 |
---------------
|
|
Packit |
577717 |
|
|
Packit |
577717 |
To install PAPI on your system:
|
|
Packit |
577717 |
|
|
Packit |
577717 |
* Find the section in INSTALL.txt that pertains to your hardware and operating
|
|
Packit |
577717 |
system.
|
|
Packit |
577717 |
* Follow the directions to install required components and build the PAPI
|
|
Packit |
577717 |
libraries.
|
|
Packit |
577717 |
* Run the test suite when you are finished to verify that everything went ok.
|
|
Packit |
577717 |
NOTE: Although we make every attempt to get all tests to PASS or SKIP on all
|
|
Packit |
577717 |
platforms, there are occasional instances of FAILures due to excessively
|
|
Packit |
577717 |
tight compliance thresholds or platform idiosyncrasies. Don't panic if one
|
|
Packit |
577717 |
or two tests FAIL. Contact us with complete output and we'll see what we can do.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
|
|
Packit |
577717 |
Using PAPI
|
|
Packit |
577717 |
----------
|
|
Packit |
577717 |
|
|
Packit |
577717 |
To use PAPI in your own programs:
|
|
Packit |
577717 |
|
|
Packit |
577717 |
* Read the PAPI Overview found at:
|
|
Packit |
577717 |
http://icl.utk.edu/projects/papi/wiki/Main_Page.
|
|
Packit |
577717 |
* Try out the utility programs in /utils to see what's in your system.
|
|
Packit |
577717 |
* Try a test program. Source for a number of tests in both C and FORTRAN is
|
|
Packit |
577717 |
available in the src/tests/ and src/ftests/ directories. Find a program
|
|
Packit |
577717 |
that's similar to what you want to do. Make sure you can build it and run it.
|
|
Packit |
577717 |
* Write a test program of your own, exercising the PAPI events and features of
|
|
Packit |
577717 |
interest to you.
|
|
Packit |
577717 |
* Go for broke. Fold PAPI calls into your sources and see what you can learn.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
|
|
Packit |
577717 |
Bugs and Questions
|
|
Packit |
577717 |
------------------
|
|
Packit |
577717 |
|
|
Packit |
577717 |
* Visit our FAQ at: <http://icl.utk.edu/papi/faq/>
|
|
Packit |
577717 |
or read a snapshot of the FAQ in papi/PAPI_FAQ.html
|
|
Packit |
577717 |
* Subscribe to the PAPI mailing list at:
|
|
Packit |
577717 |
<https://groups.google.com/a/icl.utk.edu/forum/#!forum/ptools-perfapi>
|
|
Packit |
577717 |
* Read historical postings to the list.
|
|
Packit |
577717 |
* Post questions to the list.
|