perf-kvm.txt 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. perf-kvm(1)
  2. ===========
  3. NAME
  4. ----
  5. perf-kvm - Tool to trace/measure kvm guest os
  6. SYNOPSIS
  7. --------
  8. [verse]
  9. 'perf kvm' [--host] [--guest] [--guestmount=<path>
  10. [--guestkallsyms=<path> --guestmodules=<path> | --guestvmlinux=<path>]]
  11. {top|record|report|diff|buildid-list}
  12. 'perf kvm' [--host] [--guest] [--guestkallsyms=<path> --guestmodules=<path>
  13. | --guestvmlinux=<path>] {top|record|report|diff|buildid-list}
  14. DESCRIPTION
  15. -----------
  16. There are a couple of variants of perf kvm:
  17. 'perf kvm [options] top <command>' to generates and displays
  18. a performance counter profile of guest os in realtime
  19. of an arbitrary workload.
  20. 'perf kvm record <command>' to record the performance counter profile
  21. of an arbitrary workload and save it into a perf data file. If both
  22. --host and --guest are input, the perf data file name is perf.data.kvm.
  23. If there is no --host but --guest, the file name is perf.data.guest.
  24. If there is no --guest but --host, the file name is perf.data.host.
  25. 'perf kvm report' to display the performance counter profile information
  26. recorded via perf kvm record.
  27. 'perf kvm diff' to displays the performance difference amongst two perf.data
  28. files captured via perf record.
  29. 'perf kvm buildid-list' to display the buildids found in a perf data file,
  30. so that other tools can be used to fetch packages with matching symbol tables
  31. for use by perf report.
  32. OPTIONS
  33. -------
  34. -i::
  35. --input=::
  36. Input file name.
  37. -o::
  38. --output::
  39. Output file name.
  40. --host=::
  41. Collect host side performance profile.
  42. --guest=::
  43. Collect guest side performance profile.
  44. --guestmount=<path>::
  45. Guest os root file system mount directory. Users mounts guest os
  46. root directories under <path> by a specific filesystem access method,
  47. typically, sshfs. For example, start 2 guest os. The one's pid is 8888
  48. and the other's is 9999.
  49. #mkdir ~/guestmount; cd ~/guestmount
  50. #sshfs -o allow_other,direct_io -p 5551 localhost:/ 8888/
  51. #sshfs -o allow_other,direct_io -p 5552 localhost:/ 9999/
  52. #perf kvm --host --guest --guestmount=~/guestmount top
  53. --guestkallsyms=<path>::
  54. Guest os /proc/kallsyms file copy. 'perf' kvm' reads it to get guest
  55. kernel symbols. Users copy it out from guest os.
  56. --guestmodules=<path>::
  57. Guest os /proc/modules file copy. 'perf' kvm' reads it to get guest
  58. kernel module information. Users copy it out from guest os.
  59. --guestvmlinux=<path>::
  60. Guest os kernel vmlinux.
  61. SEE ALSO
  62. --------
  63. linkperf:perf-top[1], linkperf:perf-record[1], linkperf:perf-report[1],
  64. linkperf:perf-diff[1], linkperf:perf-buildid-list[1]