blob: 1c681de1cd916d6c0fe60bb9b1987665fb95394a [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001#
2# Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
3#
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions
6# are met:
7#
8# - Redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer.
10#
11# - Redistributions in binary form must reproduce the above copyright
12# notice, this list of conditions and the following disclaimer in the
13# documentation and/or other materials provided with the distribution.
14#
15# - Neither the name of Sun Microsystems nor the names of its
16# contributors may be used to endorse or promote products derived
17# from this software without specific prior written permission.
18#
19# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
20# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
23# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30#
31
32heapViewer
33
34This agent library demonstrates how to get an easy view of the
35heap in terms of total object count and space used.
36It uses GetLoadedClasses(), SetTag(), and IterateThroughHeap()
37to count up all the objects of all the current loaded classes.
38The heap dump will happen at the event JVMTI_EVENT_VM_DEATH, or the
39event JVMTI_EVENT_DATA_DUMP_REQUEST.
40
41It also demonstrates some more robust agent error handling using
42GetErrorName(),
43
44Using the heap iterate functions, lots of statistics can be generated
45without resorting to using Byte Code Instrumentation (BCI).
46
47You can use this agent library as follows:
48
49 java -agentlib:heapViewer ...
50
51To get help on the available options try:
52
53 java -agentlib:heapViewer=help
54
55See ${JAVA_HOME}/demo/jvmti/index.html for help running and building agents.
56