1perf-check(1)
2===============
3
4NAME
5----
6perf-check - check if features are present in perf
7
8SYNOPSIS
9--------
10[verse]
11'perf check' [<options>]
12'perf check' {feature <feature_list>} [<options>]
13
14DESCRIPTION
15-----------
16With no subcommands given, 'perf check' command just prints the command
17usage on the standard output.
18
19If the subcommand 'feature' is used, then status of feature is printed
20on the standard output (unless '-q' is also passed), ie. whether it is
21compiled-in/built-in or not.
22Also, 'perf check feature' returns with exit status 0 if the feature
23is built-in, otherwise returns with exit status 1.
24
25SUBCOMMANDS
26-----------
27
28feature::
29
30        Print whether feature(s) is compiled-in or not, and also returns with an
31        exit status of 0, if passed feature(s) are compiled-in, else 1.
32
33        It expects a feature list as an argument. There can be a single feature
34        name/macro, or multiple features can also be passed as a comma-separated
35        list, in which case the exit status will be 0 only if all of the passed
36        features are compiled-in.
37
38        The feature names/macros are case-insensitive.
39
40        Example Usage:
41                perf check feature libtraceevent
42                perf check feature HAVE_LIBTRACEEVENT
43                perf check feature libtraceevent,bpf
44
45        Supported feature names/macro:
46                aio                     /  HAVE_AIO_SUPPORT
47                bpf                     /  HAVE_LIBBPF_SUPPORT
48                bpf_skeletons           /  HAVE_BPF_SKEL
49                debuginfod              /  HAVE_DEBUGINFOD_SUPPORT
50                dwarf                   /  HAVE_LIBDW_SUPPORT
51                dwarf_getlocations      /  HAVE_LIBDW_SUPPORT
52                dwarf-unwind            /  HAVE_DWARF_UNWIND_SUPPORT
53                auxtrace                /  HAVE_AUXTRACE_SUPPORT
54                libbfd                  /  HAVE_LIBBFD_SUPPORT
55                libcapstone             /  HAVE_LIBCAPSTONE_SUPPORT
56                libcrypto               /  HAVE_LIBCRYPTO_SUPPORT
57                libdw-dwarf-unwind      /  HAVE_LIBDW_SUPPORT
58                libelf                  /  HAVE_LIBELF_SUPPORT
59                libnuma                 /  HAVE_LIBNUMA_SUPPORT
60                libopencsd              /  HAVE_CSTRACE_SUPPORT
61                libperl                 /  HAVE_LIBPERL_SUPPORT
62                libpfm4                 /  HAVE_LIBPFM
63                libpython               /  HAVE_LIBPYTHON_SUPPORT
64                libslang                /  HAVE_SLANG_SUPPORT
65                libtraceevent           /  HAVE_LIBTRACEEVENT
66                libunwind               /  HAVE_LIBUNWIND_SUPPORT
67                lzma                    /  HAVE_LZMA_SUPPORT
68                numa_num_possible_cpus  /  HAVE_LIBNUMA_SUPPORT
69                zlib                    /  HAVE_ZLIB_SUPPORT
70                zstd                    /  HAVE_ZSTD_SUPPORT
71
72OPTIONS
73-------
74-q::
75--quiet::
76        Do not print any messages or warnings
77
78        This can be used along with subcommands such as 'perf check feature'
79        to hide unnecessary output in test scripts, eg.
80        'perf check feature --quiet libtraceevent'
81