stap-merge.1

   1 .\" -*- nroff -*-
   2 .TH STAP\-MERGE 1
   3 .SH NAME
   4 stap\-merge \- systemtap per-cpu binary merger
   5
   6 .\" macros
   7 .de SAMPLE
   8 .br
   9 .RS
  10 .nf
  11 .nh
  12 ..
  13 .de ESAMPLE
  14 .hy
  15 .fi
  16 .RE
  17 ..
  18
  19 .SH SYNOPSIS
  20
  21 .br
  22 .B stap\-merge
  23 [
  24 .I OPTIONS
  25 ]
  26 [
  27 .I INPUT FILENAMES
  28 ]
  29
  30 .SH DESCRIPTION
  31
  32 The stap\-merge executable applies when the \-b option has been used
  33 while running a
  34 .IR stap
  35 script.  The \-b option will generate files
  36 per\-cpu, based on the timestamp field. Then stap\-merge will
  37 merge and sort through the per-cpu files based on the timestamp
  38 field.
  39
  40 .SH OPTIONS
  41
  42 The systemtap merge executable supports the following options.
  43 .TP
  44 .B \-v
  45 Verbose mode, displays three extra fields per set of collected data.
  46 .SAMPLE
  47 .BR [cpu number, sequence number of data, the length of the data set]
  48 .ESAMPLE
  49 .TP
  50 .BI \-o " OUTPUT_FILENAME"
  51
  52 Specify the name of the file you would like the output to be
  53 redirected into.  If this option is not specified than the
  54 output will be pushed to standard out.
  55
  56 .SH EXAMPLES
  57 .SAMPLE
  58 $ stap \-v \-b \-e 'probe syscall.open { printf("%s(%d) open\\n",
  59 execname(), pid()) }'
  60
  61 .ESAMPLE
  62
  63 This should result in several
  64 .I stpd_cpu
  65 files (each labled with a number
  66 representing which cpu the file was produced from).
  67
  68 .SAMPLE
  69 $ stap\-merge \-v stpd_cpu0 stpd_cpu1
  70
  71 .ESAMPLE
  72
  73 Running the stap\-merge program in the same directory as the stap
  74 script earlier in the example, will produce an ordered sequence of
  75 packets with the three part label for each set of data.  This
  76 result will be pushed through the standard output.  An output file
  77 could have been specified using the "\-o" option.
  78
  79 .SH FILES
  80
  81 .TP
  82 Important files and their corresponding paths can be located in the
  83 stappaths (7) manual page.
  84
  85 .SH SEE ALSO
  86 .IR stapprobes (3stap),
  87 .IR stapfuncs (3stap),
  88 .IR stappaths (7),
  89 .IR staprun (8),
  90 .IR stapvars (3stap),
  91 .IR stapex (3stap),
  92 .IR stap\-server (8),
  93 .IR gdb (1)
  94
  95 .SH BUGS
  96 Use the Bugzilla link of the project web page or our mailing list.
  97 .nh
  98 .BR http://sourceware.org/systemtap/ , <systemtap@sourceware.org> .
  99 .hy