xref: /linux/tools/perf/Documentation/perf-buildid-cache.txt (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732)
1perf-buildid-cache(1)
2=====================
3
4NAME
5----
6perf-buildid-cache - Manage build-id cache.
7
8SYNOPSIS
9--------
10[verse]
11'perf buildid-cache <options>'
12
13DESCRIPTION
14-----------
15This command manages the build-id cache. It can add, remove, update and purge
16files to/from the cache. In the future it should as well set upper limits for
17the space used by the cache, etc.
18
19OPTIONS
20-------
21-a::
22--add=::
23        Add specified file to the cache.
24-k::
25--kcore::
26        Add specified kcore file to the cache. For the current host that is
27        /proc/kcore which requires root permissions to read. Be aware that
28        running 'perf buildid-cache' as root may update root's build-id cache
29        not the user's. Use the -v option to see where the file is created.
30        Note that the copied file contains only code sections not the whole core
31        image. Note also that files "kallsyms" and "modules" must also be in the
32        same directory and are also copied.  All 3 files are created with read
33        permissions for root only. kcore will not be added if there is already a
34        kcore in the cache (with the same build-id) that has the same modules at
35        the same addresses. Use the -v option to see if a copy of kcore is
36        actually made.
37-r::
38--remove=::
39        Remove a cached binary which has same build-id of specified file
40        from the cache.
41-p::
42--purge=::
43        Purge all cached binaries including older caches which have specified
44	path from the cache.
45-M::
46--missing=::
47	List missing build ids in the cache for the specified file.
48-u::
49--update=::
50	Update specified file of the cache. Note that this doesn't remove
51	older entires since those may be still needed for annotating old
52	(or remote) perf.data. Only if there is already a cache which has
53	exactly same build-id, that is replaced by new one. It can be used
54	to update kallsyms and kernel dso to vmlinux in order to support
55	annotation.
56
57-v::
58--verbose::
59	Be more verbose.
60
61SEE ALSO
62--------
63linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-buildid-list[1]
64