xref: /titanic_51/usr/src/man/man1/tnfxtract.1 (revision 812e8c05270efb3334ff7b081079ed4b71c712c8)
te
Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
tnfxtract 1 "19 Aug 2003" "SunOS 5.11" "User Commands"
NAME
tnfxtract - extract kernel probes output into a trace file
SYNOPSIS

tnfxtract [-d dumpfile -n namelist] tnf_file
DESCRIPTION

The tnfxtract utility collects kernel trace output from an in-core buffer in the Solaris kernel, or from the memory image of a crashed system, and generates a binary TNF trace file like those produced directly by user programs being traced.

Either both or neither of the -d and -n options must be specified. If neither is specified, trace output is extracted from the running kernel. If both are specified, the -d argument names the file containing the (crashed) system memory image, and the -n argument names the file containing the symbol table for the system memory image.

The TNF trace file tnf_file produced is exactly the same size as the in-core buffer; it is essentially a snapshot of that buffer. It is legal to run tnfxtract while kernel tracing is active, i.e., while the in-core buffer is being written. tnfxtract insures that the output file it generates is low-level consistent, that is, that only whole probes are written out, and that internal data structures in the buffer are not corrupted because the buffer is being concurrently written.

The TNF trace file generated is suitable as input to tnfdump(1), which will generate an ASCII file.

OPTIONS

The following options are supported:

-d dumpfile

Uses dumpfile as the system memory image, instead of the running kernel. The dumpfile is normally the path name of a file generated by the savecore utility.

-n namelist

Uses namelist as the file containing the symbol table information for the given dumpfile.

OPERANDS

The following operand is supported:

tnf_file

Output file generated by tnfxtract based on kernel trace output from an in-core buffer in the Solaris kernel.

EXAMPLES

Example 1 Extracting probes from a running kernel

Extract probes from the running kernel into ktrace.out:

example% tnfxtract ktrace.out

Example 2 Extracting probes from a kernel crash dump

Extract probes from a kernel crash dump into ktrace.out:

example% tnfxtract -d /var/crash/`uname -n`/vmcore.0 \e
 -n /var/crash/`uname -n`/unix.0 ktrace.out
EXIT STATUS

The following exit values are returned:

0

Successful completion.

>0

An error occurred.

SEE ALSO

prex(1), tnfdump(1), savecore(1M), tnf_kernel_probes(4), attributes(5)