GNU Linux-libre 4.19.211-gnu1
[releases.git] / tools / perf / Documentation / perf-buildid-cache.txt
1 perf-buildid-cache(1)
2 =====================
3
4 NAME
5 ----
6 perf-buildid-cache - Manage build-id cache.
7
8 SYNOPSIS
9 --------
10 [verse]
11 'perf buildid-cache <options>'
12
13 DESCRIPTION
14 -----------
15 This command manages the build-id cache. It can add, remove, update and purge
16 files to/from the cache. In the future it should as well set upper limits for
17 the space used by the cache, etc.
18 This also scans the target binary for SDT (Statically Defined Tracing) and
19 record it along with the buildid-cache, which will be used by perf-probe.
20 For more details, see linkperf:perf-probe[1].
21
22 OPTIONS
23 -------
24 -a::
25 --add=::
26         Add specified file to the cache.
27 -f::
28 --force::
29         Don't complain, do it.
30 -k::
31 --kcore::
32         Add specified kcore file to the cache. For the current host that is
33         /proc/kcore which requires root permissions to read. Be aware that
34         running 'perf buildid-cache' as root may update root's build-id cache
35         not the user's. Use the -v option to see where the file is created.
36         Note that the copied file contains only code sections not the whole core
37         image. Note also that files "kallsyms" and "modules" must also be in the
38         same directory and are also copied.  All 3 files are created with read
39         permissions for root only. kcore will not be added if there is already a
40         kcore in the cache (with the same build-id) that has the same modules at
41         the same addresses. Use the -v option to see if a copy of kcore is
42         actually made.
43 -r::
44 --remove=::
45         Remove a cached binary which has same build-id of specified file
46         from the cache.
47 -p::
48 --purge=::
49         Purge all cached binaries including older caches which have specified
50         path from the cache.
51 -P::
52 --purge-all::
53         Purge all cached binaries. This will flush out entire cache.
54 -M::
55 --missing=::
56         List missing build ids in the cache for the specified file.
57 -u::
58 --update=::
59         Update specified file of the cache. Note that this doesn't remove
60         older entires since those may be still needed for annotating old
61         (or remote) perf.data. Only if there is already a cache which has
62         exactly same build-id, that is replaced by new one. It can be used
63         to update kallsyms and kernel dso to vmlinux in order to support
64         annotation.
65 -l::
66 --list::
67         List all valid binaries from cache.
68 -v::
69 --verbose::
70         Be more verbose.
71
72 --target-ns=PID:
73         Obtain mount namespace information from the target pid.  This is
74         used when creating a uprobe for a process that resides in a
75         different mount namespace from the perf(1) utility.
76
77 SEE ALSO
78 --------
79 linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-buildid-list[1]