eheapprof (Output of extended thread dump containing the Explicit heap detailed information)
- Organization of this page
Format
eheapprof [-i|-f] [-force] [-freeratio] -p process-ID
Function
This command outputs the extended thread dump containing the Explicit heap detailed information for java processes of the process ID specified in arguments. You can also output the statistical information of an object within the Explicit memory block, and the release ratio information of the Explicit memory block to an extended thread dump.
Arguments
- -i
-
Displays a message confirming the execution of the output processing for an extended thread dump containing the Explicit heap detailed information. You input either y or n. If you input y, the extended thread dump containing the Explicit heap detailed information will output. If you input n, no information will be displayed and the processing will terminate. Even if you omit this option, the option is valid as long as the -f option is not specified.
- -f
-
Disables the -i option. If you omit this option, the -i option will become valid.
- -force
-
Requests the output of an extended thread dump for the java process indicated by the process ID that is specified with the -p option, without confirming the existence of the /tmp/hsperfdata_user-name/process-ID file created in the java process.
Note that this option is for UNIX.
- -freeratio
-
Enables the output of the object release ratio information of the Explicit memory block and outputs an extended thread dump.
When you execute the eheapprof command by specifying this option, JavaVM executes the following process and acquires the object release ratio information.
-
Full GC
-
An Explicit memory block release process
The execution of these processes lead to a risk of stopping the execution of an application for a few seconds and hence we recommend that you output the object release ratio information of the Explicit memory block during system development or when operations are stopped.
-
- -p process-ID
-
Specifies the process ID of the java program that outputs the extended thread dump containing the Explicit heap detailed information.
Return values
- 0:
-
Terminated normally.
- 1:
-
Terminated abnormally.
- 2:
-
There is no response indicating that the output processing has terminated within the fixed time for the extended thread dump containing the Explicit heap detailed information.
Output messages
If the following error messages or warning messages are issued, the extended thread dump containing the Explicit heap detailed information is not output:
|
No. |
Error message |
Explanation |
|---|---|---|
|
1 |
usage: eheapprof [-f|-i] [-freeratio] -p process-id |
The argument specified in the eheapprof command is wrong. |
|
2 |
eheapprof: illegal option -- option |
option specified in the eheapprof command is invalid. |
|
3 |
process-ID: Now processing previous request, this request canceled |
The process indicated by process-ID specified in the argument of the eheapprof command outputs the current Explicit heap detailed information. |
|
4 |
process-ID: Not owner |
0 is specified in process-ID specified in the argument of the eheapprof command. |
|
5 |
eheapprof: can't create work file at temporary directory , this request canceled |
If the user does not have permission to reference or write data into the directory for temporary files, the extended thread dump containing the Explicit heap detailed information cannot be output. The output request for the extended thread dump containing the Explicit heap detailed information is cancelled. |
|
6 |
eheapprof: can't get temporary directory, this request canceled |
If the directory for temporary files cannot be acquired, the extended thread dump containing the Explicit heap detailed information cannot be output. The output request for the extended thread dump containing the Explicit heap detailed information is cancelled. |
|
7 |
eheapprof: please delete name-of-undeleted-file in full-path-of-undeleted-file |
The internal files could not be deleted when the eheapprof command is terminated. Delete the un-deleted files that exist in the full path of the un-deleted files. |
|
8 |
eheapprof: unexpected error occurred: error-cause |
An unexpected error occurred when executing the eheapprof command. error-cause might display the followings:
|
|
9 |
eheapprof: can't communicate with process process-ID |
There is a problem with the process indicated by process-ID specified in the argument of the eheapprof command and an error occurred during the communication, and therefore, the communication cannot be performed. Alternatively, the process indicated by process-ID specified in the argument of the eheapprof command does not exist. |
|
10 |
process-ID: Timeout occurred. Java process not responding |
The process indicated by process-id specified in the argument of the eheapprof command did not return a response indicating that the output processing terminated within the fixed time for the Explicit heap detailed information. |
|
No. |
Error message |
Description |
|---|---|---|
|
1 |
usage: eheapprof [-f|-i] [-force] [-freeratio] -p process-id |
The argument specified in the eheapprof command is wrong. |
|
2 |
eheapprof: illegal option -- option |
option specified in the eheapprof command is invalid. |
|
3 |
process-ID: Now processing previous request, this request canceled |
The process indicated by process-ID specified in the argument of the eheapprof command outputs the current Explicit heap detailed information. |
|
4 |
process-ID: No such process |
The process indicated by process-ID specified in the argument of the eheapprof command is not found or the process indicated by process-ID specified in the eheapprof command is not a java process. |
|
5 |
process-ID: Not owner |
The user is not the owner of the process of process-ID specified in the argument of the eheapprof command. |
|
6 |
eheapprof: can't create work file at /tmp , this request canceled |
If the user does not have permission to reference or write data into the directory for temporary files, the extended thread dump containing the Explicit heap detailed information cannot be output. The output request for the extended thread dump containing the Explicit heap detailed information is cancelled. |
|
7 |
eheapprof: please delete name-of-undeleted-file in full-path-of-undeleted-file |
The internal files could not be deleted when the eheapprof command ends. Delete the un-deleted files that exist in the full path of the un-deleted files. |
|
8 |
eheapprof: unexpected error occurred: error-cause |
An unexpected error occurred when executing the eheapprof command. error-cause might display the following:
|
|
9 |
process-ID: Timeout occurred. Java process not responding |
The process indicated by process-id specified in the argument of the eheapprof command did not return a response indicating that the output processing has terminated within the fixed time for the Explicit heap detailed information. |
Notes
-
The eheapprof command is provided as a utility for developing programs. Do not use this command in system operations.
-
The eheapprof command cannot be executed concurrently for the same java process. You execute the command after the Explicit heap detailed information is output to the extended thread dump by the earlier eheapprof command.
-
In Windows, communication is initialized using MailSlot, when a Java process is started. If this initialization fails, a message is displayed and the processing is interrupted.
-
In Windows, the eheapprof command can also be executed by the user who is not a java process owner indicated by the process ID specified in the argument.
-
In UNIX, if the user, who is not a java process owner indicated by the process ID specified in the argument, executes this command, a message is output and the processing will end. However, if the user is the root, the processing will continue.
-
In UNIX, the eheapprof command sends the SIGQUIT signal to the specified process. If a non-java program is specified by mistake, other programs might stop.
-
In UNIX, you use the /tmp/hsperfdata_user-name/process-ID file, when executing the eheapprof command. If the applicable file do not exist, the extended thread dump containing the Explicit heap detailed information cannot be output by the eheapprof command. However, if the -force option is specified, the output of an extended thread dump is requested for the java process indicated by the process ID that is specified in the -p option without confirming the existence of the /tmp/hsperfdata_user-name/process-ID file.