perf tools: Add new mem command for memory access profiling
[linux-3.10.git] / tools / perf / Documentation / perf-mem.txt
1 perf-mem(1)
2 ===========
3
4 NAME
5 ----
6 perf-mem - Profile memory accesses
7
8 SYNOPSIS
9 --------
10 [verse]
11 'perf mem' [<options>] (record [<command>] | report)
12
13 DESCRIPTION
14 -----------
15 "perf mem -t <TYPE> record" runs a command and gathers memory operation data
16 from it, into perf.data. Perf record options are accepted and are passed through.
17
18 "perf mem -t <TYPE> report" displays the result. It invokes perf report with the
19 right set of options to display a memory access profile.
20
21 OPTIONS
22 -------
23 <command>...::
24         Any command you can specify in a shell.
25
26 -t::
27 --type=::
28         Select the memory operation type: load or store (default: load)
29
30 -D::
31 --dump-raw-samples=::
32         Dump the raw decoded samples on the screen in a format that is easy to parse with
33         one sample per line.
34
35 -x::
36 --field-separator::
37         Specify the field separator used when dump raw samples (-D option). By default,
38         The separator is the space character.
39
40 -C::
41 --cpu-list::
42         Restrict dump of raw samples to those provided via this option. Note that the same
43         option can be passed in record mode. It will be interpreted the same way as perf
44         record.
45
46 SEE ALSO
47 --------
48 linkperf:perf-record[1], linkperf:perf-report[1]