GNU Linux-libre 4.19.211-gnu1
[releases.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' {record|stat} [<options>]
12
13 DESCRIPTION
14 -----------
15 There are two variants of perf kmem:
16
17   'perf kmem record <command>' to record the kmem events
18   of an arbitrary workload.
19
20   'perf kmem stat' to report kernel memory statistics.
21
22 OPTIONS
23 -------
24 -i <file>::
25 --input=<file>::
26         Select the input file (default: perf.data unless stdin is a fifo)
27
28 -f::
29 --force::
30         Don't do ownership validation
31
32 -v::
33 --verbose::
34         Be more verbose. (show symbol address, etc)
35
36 --caller::
37         Show per-callsite statistics
38
39 --alloc::
40         Show per-allocation statistics
41
42 -s <key[,key2...]>::
43 --sort=<key[,key2...]>::
44         Sort the output (default: 'frag,hit,bytes' for slab and 'bytes,hit'
45         for page).  Available sort keys are 'ptr, callsite, bytes, hit,
46         pingpong, frag' for slab and 'page, callsite, bytes, hit, order,
47         migtype, gfp' for page.  This option should be preceded by one of the
48         mode selection options - i.e. --slab, --page, --alloc and/or --caller.
49
50 -l <num>::
51 --line=<num>::
52         Print n lines only
53
54 --raw-ip::
55         Print raw ip instead of symbol
56
57 --slab::
58         Analyze SLAB allocator events.
59
60 --page::
61         Analyze page allocator events
62
63 --live::
64         Show live page stat.  The perf kmem shows total allocation stat by
65         default, but this option shows live (currently allocated) pages
66         instead.  (This option works with --page option only)
67
68 --time=<start>,<stop>::
69         Only analyze samples within given time window: <start>,<stop>. Times
70         have the format seconds.microseconds. If start is not given (i.e., time
71         string is ',x.y') then analysis starts at the beginning of the file. If
72         stop time is not given (i.e, time string is 'x.y,') then analysis goes
73         to end of file.
74
75 SEE ALSO
76 --------
77 linkperf:perf-record[1]