perf-check.txt 3.1 KB

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