1 TNFXTRACT(1)                     User Commands                    TNFXTRACT(1)
   2 
   3 
   4 
   5 NAME
   6        tnfxtract - extract kernel probes output into a trace file
   7 
   8 SYNOPSIS
   9        tnfxtract [-d dumpfile -n namelist] tnf_file
  10 
  11 
  12 DESCRIPTION
  13        The tnfxtract utility collects kernel trace output from an in-core
  14        buffer in the Solaris kernel, or from the memory image of a crashed
  15        system, and generates a binary TNF trace file like those produced
  16        directly by user programs being traced.
  17 
  18 
  19        Either both or neither of the -d and -n options must be specified.  If
  20        neither is specified, trace output is extracted from the running
  21        kernel. If both are specified, the -d argument names the file
  22        containing the (crashed) system memory image, and the -n argument names
  23        the file containing the symbol table for the system memory image.
  24 
  25 
  26        The TNF trace file tnf_file produced is exactly the same size as the
  27        in-core buffer; it is essentially a snapshot of that buffer.  It is
  28        legal to run tnfxtract while kernel tracing is active, i.e., while the
  29        in-core buffer is being written. tnfxtract insures that the output file
  30        it generates is low-level consistent, that is, that only whole probes
  31        are written out, and that internal data structures in the buffer are
  32        not corrupted because the buffer is being concurrently written.
  33 
  34 
  35        The TNF trace file generated is suitable as input to tnfdump(1), which
  36        will generate an ASCII file.
  37 
  38 OPTIONS
  39        The following options are supported:
  40 
  41        -d dumpfile
  42                       Uses dumpfile as the system memory image, instead of the
  43                       running kernel.  The dumpfile is normally the path name
  44                       of a file generated by the savecore utility.
  45 
  46 
  47        -n namelist
  48                       Uses namelist as the file containing the symbol table
  49                       information for the given dumpfile.
  50 
  51 
  52 OPERANDS
  53        The following operand is supported:
  54 
  55        tnf_file
  56                    Output file generated by tnfxtract based on kernel trace
  57                    output from an in-core buffer in the Solaris kernel.
  58 
  59 
  60 EXAMPLES
  61        Example 1 Extracting probes from a running kernel
  62 
  63 
  64        Extract probes from the running kernel into ktrace.out:
  65 
  66 
  67          example% tnfxtract ktrace.out
  68 
  69 
  70 
  71        Example 2 Extracting probes from a kernel crash dump
  72 
  73 
  74        Extract probes from a kernel crash dump into ktrace.out:
  75 
  76 
  77          example% tnfxtract -d /var/crash/data/UUID/core.0 \
  78             -n /var/crash/data/UUID/unix.0 ktrace.out
  79 
  80 
  81 
  82 EXIT STATUS
  83        The following exit values are returned:
  84 
  85        0
  86              Successful completion.
  87 
  88 
  89        >0
  90              An error occurred.
  91 
  92 
  93 SEE ALSO
  94        prex(1), tnfdump(1), savecore(1M), tnf_kernel_probes(4), attributes(5)
  95 
  96 
  97 
  98                                February 13, 2017                  TNFXTRACT(1)