Merge tag 'backlight-next-6.9' of git://git.kernel.org/pub/scm/linux/kernel/git/lee...
[linux-2.6-microblaze.git] / tools / perf / Documentation / perf-kmem.txt
1 perf-kmem(1)
2 ============
3
4 NAME
5 ----
6 perf-kmem - Tool to trace/measure kernel memory properties
7
8 SYNOPSIS
9 --------
10 [verse]
11 'perf kmem' [<options>] {record|stat}
12
13 DESCRIPTION
14 -----------
15 There are two variants of perf kmem:
16
17   'perf kmem [<options>] record [<perf-record-options>] <command>' to
18   record the kmem events of an arbitrary workload. Additional 'perf
19   record' options may be specified after record, such as '-o' to
20   change the output file name.
21
22   'perf kmem [<options>] stat' to report kernel memory statistics.
23
24 OPTIONS
25 -------
26 -i <file>::
27 --input=<file>::
28         For stat, select the input file (default: perf.data unless stdin is a
29         fifo)
30
31 -f::
32 --force::
33         Don't do ownership validation
34
35 -v::
36 --verbose::
37         Be more verbose. (show symbol address, etc)
38
39 --caller::
40         Show per-callsite statistics
41
42 --alloc::
43         Show per-allocation statistics
44
45 -s <key[,key2...]>::
46 --sort=<key[,key2...]>::
47         Sort the output (default: 'frag,hit,bytes' for slab and 'bytes,hit'
48         for page).  Available sort keys are 'ptr, callsite, bytes, hit,
49         pingpong, frag' for slab and 'page, callsite, bytes, hit, order,
50         migtype, gfp' for page.  This option should be preceded by one of the
51         mode selection options - i.e. --slab, --page, --alloc and/or --caller.
52
53 -l <num>::
54 --line=<num>::
55         Print n lines only
56
57 --raw-ip::
58         Print raw ip instead of symbol
59
60 --slab::
61         Analyze SLAB allocator events.
62
63 --page::
64         Analyze page allocator events
65
66 --live::
67         Show live page stat.  The perf kmem shows total allocation stat by
68         default, but this option shows live (currently allocated) pages
69         instead.  (This option works with --page option only)
70
71 --time=<start>,<stop>::
72         Only analyze samples within given time window: <start>,<stop>. Times
73         have the format seconds.microseconds. If start is not given (i.e., time
74         string is ',x.y') then analysis starts at the beginning of the file. If
75         stop time is not given (i.e, time string is 'x.y,') then analysis goes
76         to end of file.
77
78 SEE ALSO
79 --------
80 linkperf:perf-record[1]