]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - tools/kvm/kvm_stat/kvm_stat
3 # top-like utility for displaying kvm statistics
5 # Copyright 2006-2008 Qumranet Technologies
6 # Copyright 2008-2011 Red Hat, Inc.
9 # Avi Kivity <avi@redhat.com>
11 # This work is licensed under the terms of the GNU GPL, version 2. See
12 # the COPYING file in the top-level directory.
13 """The kvm_stat module outputs statistics about running KVM VMs
15 Three different ways of output formatting are available:
16 - as a top-like text ui
17 - in a key -> value format
18 - in an all keys, all values format
20 The data is sampled from the KVM's debugfs entries and its perf events.
22 from __future__
import print_function
36 from collections
import defaultdict
40 'EXTERNAL_INTERRUPT': 1,
42 'PENDING_INTERRUPT': 7,
66 'MWAIT_INSTRUCTION': 36,
67 'MONITOR_INSTRUCTION': 39,
68 'PAUSE_INSTRUCTION': 40,
69 'MCE_DURING_VMENTRY': 41,
70 'TPR_BELOW_THRESHOLD': 43,
111 'CR0_SEL_WRITE': 0x065,
135 'TASK_SWITCH': 0x07d,
136 'FERR_FREEZE': 0x07e,
155 # EC definition of HSR (from arch/arm64/include/asm/kvm_arm.h)
156 AARCH64_EXIT_REASONS
= {
194 # From include/uapi/linux/kvm.h, KVM_EXIT_xxx
195 USERSPACE_EXIT_REASONS
= {
203 'IRQ_WINDOW_OPEN': 7,
213 'INTERNAL_ERROR': 17,
224 'SET_FILTER': 0x40082406,
225 'ENABLE': 0x00002400,
226 'DISABLE': 0x00002401,
230 ENCODING
= locale
.getpreferredencoding(False)
234 """Encapsulates global architecture specific data.
236 Contains the performance event open syscall and ioctl numbers, as
237 well as the VM exit reasons for the architecture it runs on.
242 machine
= os
.uname()[4]
244 if machine
.startswith('ppc'):
246 elif machine
.startswith('aarch64'):
248 elif machine
.startswith('s390'):
252 for line
in open('/proc/cpuinfo'):
253 if not line
.startswith('flags'):
258 return ArchX86(VMX_EXIT_REASONS
)
260 return ArchX86(SVM_EXIT_REASONS
)
265 def __init__(self
, exit_reasons
):
266 self
.sc_perf_evt_open
= 298
267 self
.ioctl_numbers
= IOCTL_NUMBERS
268 self
.exit_reasons
= exit_reasons
273 self
.sc_perf_evt_open
= 319
274 self
.ioctl_numbers
= IOCTL_NUMBERS
275 self
.ioctl_numbers
['ENABLE'] = 0x20002400
276 self
.ioctl_numbers
['DISABLE'] = 0x20002401
277 self
.ioctl_numbers
['RESET'] = 0x20002403
279 # PPC comes in 32 and 64 bit and some generated ioctl
280 # numbers depend on the wordsize.
281 char_ptr_size
= ctypes
.sizeof(ctypes
.c_char_p
)
282 self
.ioctl_numbers
['SET_FILTER'] = 0x80002406 | char_ptr_size
<< 16
283 self
.exit_reasons
= {}
288 self
.sc_perf_evt_open
= 241
289 self
.ioctl_numbers
= IOCTL_NUMBERS
290 self
.exit_reasons
= AARCH64_EXIT_REASONS
293 class ArchS390(Arch
):
295 self
.sc_perf_evt_open
= 331
296 self
.ioctl_numbers
= IOCTL_NUMBERS
297 self
.exit_reasons
= None
299 ARCH
= Arch
.get_arch()
302 class perf_event_attr(ctypes
.Structure
):
303 """Struct that holds the necessary data to set up a trace event.
305 For an extensive explanation see perf_event_open(2) and
306 include/uapi/linux/perf_event.h, struct perf_event_attr
308 All fields that are not initialized in the constructor are 0.
311 _fields_
= [('type', ctypes
.c_uint32
),
312 ('size', ctypes
.c_uint32
),
313 ('config', ctypes
.c_uint64
),
314 ('sample_freq', ctypes
.c_uint64
),
315 ('sample_type', ctypes
.c_uint64
),
316 ('read_format', ctypes
.c_uint64
),
317 ('flags', ctypes
.c_uint64
),
318 ('wakeup_events', ctypes
.c_uint32
),
319 ('bp_type', ctypes
.c_uint32
),
320 ('bp_addr', ctypes
.c_uint64
),
321 ('bp_len', ctypes
.c_uint64
),
325 super(self
.__class
__, self
).__init
__()
326 self
.type = PERF_TYPE_TRACEPOINT
327 self
.size
= ctypes
.sizeof(self
)
328 self
.read_format
= PERF_FORMAT_GROUP
331 PERF_TYPE_TRACEPOINT
= 2
332 PERF_FORMAT_GROUP
= 1 << 3
334 PATH_DEBUGFS_TRACING
= '/sys/kernel/debug/tracing'
335 PATH_DEBUGFS_KVM
= '/sys/kernel/debug/kvm'
339 """Represents a perf event group."""
344 def add_event(self
, event
):
345 self
.events
.append(event
)
348 """Returns a dict with 'event name: value' for all events in the
351 Values are read by reading from the file descriptor of the
352 event that is the group leader. See perf_event_open(2) for
355 Read format for the used event configuration is:
357 u64 nr; /* The number of events */
359 u64 value; /* The value of the event */
364 length
= 8 * (1 + len(self
.events
))
365 read_format
= 'xxxxxxxx' + 'Q' * len(self
.events
)
366 return dict(zip([event
.name
for event
in self
.events
],
367 struct
.unpack(read_format
,
368 os
.read(self
.events
[0].fd
, length
))))
372 """Represents a performance event and manages its life cycle."""
373 def __init__(self
, name
, group
, trace_cpu
, trace_pid
, trace_point
,
374 trace_filter
, trace_set
='kvm'):
375 self
.libc
= ctypes
.CDLL('libc.so.6', use_errno
=True)
376 self
.syscall
= self
.libc
.syscall
379 self
.setup_event(group
, trace_cpu
, trace_pid
, trace_point
,
380 trace_filter
, trace_set
)
383 """Closes the event's file descriptor.
385 As no python file object was created for the file descriptor,
386 python will not reference count the descriptor and will not
387 close it itself automatically, so we do it.
393 def perf_event_open(self
, attr
, pid
, cpu
, group_fd
, flags
):
394 """Wrapper for the sys_perf_evt_open() syscall.
396 Used to set up performance events, returns a file descriptor or -1
401 - struct perf_event_attr *
402 - pid or -1 to monitor all pids
403 - cpu number or -1 to monitor all cpus
404 - The file descriptor of the group leader or -1 to create a group.
408 return self
.syscall(ARCH
.sc_perf_evt_open
, ctypes
.pointer(attr
),
409 ctypes
.c_int(pid
), ctypes
.c_int(cpu
),
410 ctypes
.c_int(group_fd
), ctypes
.c_long(flags
))
412 def setup_event_attribute(self
, trace_set
, trace_point
):
413 """Returns an initialized ctype perf_event_attr struct."""
415 id_path
= os
.path
.join(PATH_DEBUGFS_TRACING
, 'events', trace_set
,
418 event_attr
= perf_event_attr()
419 event_attr
.config
= int(open(id_path
).read())
422 def setup_event(self
, group
, trace_cpu
, trace_pid
, trace_point
,
423 trace_filter
, trace_set
):
424 """Sets up the perf event in Linux.
426 Issues the syscall to register the event in the kernel and
427 then sets the optional filter.
431 event_attr
= self
.setup_event_attribute(trace_set
, trace_point
)
433 # First event will be group leader.
436 # All others have to pass the leader's descriptor instead.
438 group_leader
= group
.events
[0].fd
440 fd
= self
.perf_event_open(event_attr
, trace_pid
,
441 trace_cpu
, group_leader
, 0)
443 err
= ctypes
.get_errno()
444 raise OSError(err
, os
.strerror(err
),
445 'while calling sys_perf_event_open().')
448 fcntl
.ioctl(fd
, ARCH
.ioctl_numbers
['SET_FILTER'],
454 """Enables the trace event in the kernel.
456 Enabling the group leader makes reading counters from it and the
457 events under it possible.
460 fcntl
.ioctl(self
.fd
, ARCH
.ioctl_numbers
['ENABLE'], 0)
463 """Disables the trace event in the kernel.
465 Disabling the group leader makes reading all counters under it
469 fcntl
.ioctl(self
.fd
, ARCH
.ioctl_numbers
['DISABLE'], 0)
472 """Resets the count of the trace event in the kernel."""
473 fcntl
.ioctl(self
.fd
, ARCH
.ioctl_numbers
['RESET'], 0)
476 class Provider(object):
477 """Encapsulates functionalities used by all providers."""
479 def is_field_wanted(fields_filter
, field
):
480 """Indicate whether field is valid according to fields_filter."""
481 if not fields_filter
or fields_filter
== "help":
483 return re
.match(fields_filter
, field
) is not None
487 """Returns os.walk() data for specified directory.
489 As it is only a wrapper it returns the same 3-tuple of (dirpath,
490 dirnames, filenames).
492 return next(os
.walk(path
))
495 class TracepointProvider(Provider
):
496 """Data provider for the stats class.
498 Manages the events/groups from which it acquires its data.
501 def __init__(self
, pid
, fields_filter
):
502 self
.group_leaders
= []
503 self
.filters
= self
.get_filters()
504 self
.update_fields(fields_filter
)
509 """Returns a dict of trace events, their filter ids and
510 the values that can be filtered.
512 Trace events can be filtered for special values by setting a
513 filter string via an ioctl. The string normally has the format
514 identifier==value. For each filter a new event will be created, to
515 be able to distinguish the events.
519 filters
['kvm_userspace_exit'] = ('reason', USERSPACE_EXIT_REASONS
)
520 if ARCH
.exit_reasons
:
521 filters
['kvm_exit'] = ('exit_reason', ARCH
.exit_reasons
)
524 def get_available_fields(self
):
525 """Returns a list of available event's of format 'event name(filter
528 All available events have directories under
529 /sys/kernel/debug/tracing/events/ which export information
530 about the specific event. Therefore, listing the dirs gives us
531 a list of all available events.
533 Some events like the vm exit reasons can be filtered for
534 specific values. To take account for that, the routine below
535 creates special fields with the following format:
536 event name(filter name)
539 path
= os
.path
.join(PATH_DEBUGFS_TRACING
, 'events', 'kvm')
540 fields
= self
.walkdir(path
)[1]
543 if field
in self
.filters
:
544 filter_name_
, filter_dicts
= self
.filters
[field
]
545 for name
in filter_dicts
:
546 extra
.append(field
+ '(' + name
+ ')')
550 def update_fields(self
, fields_filter
):
551 """Refresh fields, applying fields_filter"""
552 self
._fields
= [field
for field
in self
.get_available_fields()
553 if self
.is_field_wanted(fields_filter
, field
)]
556 def get_online_cpus():
557 """Returns a list of cpu id integers."""
558 def parse_int_list(list_string
):
559 """Returns an int list from a string of comma separated integers and
562 members
= list_string
.split(',')
564 for member
in members
:
565 if '-' not in member
:
566 integers
.append(int(member
))
568 int_range
= member
.split('-')
569 integers
.extend(range(int(int_range
[0]),
570 int(int_range
[1]) + 1))
574 with
open('/sys/devices/system/cpu/online') as cpu_list
:
575 cpu_string
= cpu_list
.readline()
576 return parse_int_list(cpu_string
)
578 def setup_traces(self
):
579 """Creates all event and group objects needed to be able to retrieve
581 fields
= self
.get_available_fields()
583 # Fetch list of all threads of the monitored pid, as qemu
584 # starts a thread for each vcpu.
585 path
= os
.path
.join('/proc', str(self
._pid
), 'task')
586 groupids
= self
.walkdir(path
)[1]
588 groupids
= self
.get_online_cpus()
590 # The constant is needed as a buffer for python libs, std
591 # streams and other files that the script opens.
592 newlim
= len(groupids
) * len(fields
) + 50
594 softlim_
, hardlim
= resource
.getrlimit(resource
.RLIMIT_NOFILE
)
597 # Now we need CAP_SYS_RESOURCE, to increase the hard limit.
598 resource
.setrlimit(resource
.RLIMIT_NOFILE
, (newlim
, newlim
))
600 # Raising the soft limit is sufficient.
601 resource
.setrlimit(resource
.RLIMIT_NOFILE
, (newlim
, hardlim
))
604 sys
.exit("NOFILE rlimit could not be raised to {0}".format(newlim
))
606 for groupid
in groupids
:
611 match
= re
.match(r
'(.*)\((.*)\)', name
)
613 tracepoint
, sub
= match
.groups()
614 tracefilter
= ('%s==%d\0' %
615 (self
.filters
[tracepoint
][0],
616 self
.filters
[tracepoint
][1][sub
]))
618 # From perf_event_open(2):
619 # pid > 0 and cpu == -1
620 # This measures the specified process/thread on any CPU.
622 # pid == -1 and cpu >= 0
623 # This measures all processes/threads on the specified CPU.
624 trace_cpu
= groupid
if self
._pid
== 0 else -1
625 trace_pid
= int(groupid
) if self
._pid
!= 0 else -1
627 group
.add_event(Event(name
=name
,
631 trace_point
=tracepoint
,
632 trace_filter
=tracefilter
))
634 self
.group_leaders
.append(group
)
641 def fields(self
, fields
):
642 """Enables/disables the (un)wanted events"""
643 self
._fields
= fields
644 for group
in self
.group_leaders
:
645 for index
, event
in enumerate(group
.events
):
646 if event
.name
in fields
:
650 # Do not disable the group leader.
651 # It would disable all of its events.
661 """Changes the monitored pid by setting new traces."""
663 # The garbage collector will get rid of all Event/Group
664 # objects and open files after removing the references.
665 self
.group_leaders
= []
667 self
.fields
= self
._fields
669 def read(self
, by_guest
=0):
670 """Returns 'event name: current value' for all enabled events."""
671 ret
= defaultdict(int)
672 for group
in self
.group_leaders
:
673 for name
, val
in group
.read().items():
674 if name
in self
._fields
:
679 """Reset all field counters"""
680 for group
in self
.group_leaders
:
681 for event
in group
.events
:
685 class DebugfsProvider(Provider
):
686 """Provides data from the files that KVM creates in the kvm debugfs
688 def __init__(self
, pid
, fields_filter
, include_past
):
689 self
.update_fields(fields_filter
)
697 def get_available_fields(self
):
698 """"Returns a list of available fields.
700 The fields are all available KVM debugfs files
703 return self
.walkdir(PATH_DEBUGFS_KVM
)[2]
705 def update_fields(self
, fields_filter
):
706 """Refresh fields, applying fields_filter"""
707 self
._fields
= [field
for field
in self
.get_available_fields()
708 if self
.is_field_wanted(fields_filter
, field
)]
715 def fields(self
, fields
):
716 self
._fields
= fields
727 vms
= self
.walkdir(PATH_DEBUGFS_KVM
)[1]
731 self
.paths
= filter(lambda x
: "{}-".format(pid
) in x
, vms
)
738 def read(self
, reset
=0, by_guest
=0):
739 """Returns a dict with format:'file name / field -> current value'.
743 1 reset field counts to 0
744 2 restore the original field counts
749 # If no debugfs filtering support is available, then don't read.
756 for entry
in os
.walk(PATH_DEBUGFS_KVM
):
760 for field
in self
._fields
:
761 value
= self
.read_field(field
, path
)
764 self
._baseline
[key
] = value
766 self
._baseline
[key
] = 0
767 if self
._baseline
.get(key
, -1) == -1:
768 self
._baseline
[key
] = value
769 increment
= (results
.get(field
, 0) + value
-
770 self
._baseline
.get(key
, 0))
772 pid
= key
.split('-')[0]
774 results
[pid
] += increment
776 results
[pid
] = increment
778 results
[field
] = increment
782 def read_field(self
, field
, path
):
783 """Returns the value of a single field from a specific VM."""
785 return int(open(os
.path
.join(PATH_DEBUGFS_KVM
,
793 """Reset field counters"""
798 """Reset field counters"""
804 """Manages the data providers and the data they provide.
806 It is used to set filters on the provider's data and collect all
810 def __init__(self
, options
):
811 self
.providers
= self
.get_providers(options
)
812 self
._pid
_filter
= options
.pid
813 self
._fields
_filter
= options
.fields
817 def get_providers(options
):
818 """Returns a list of data providers depending on the passed options."""
822 providers
.append(DebugfsProvider(options
.pid
, options
.fields
,
823 options
.dbgfs_include_past
))
824 if options
.tracepoints
or not providers
:
825 providers
.append(TracepointProvider(options
.pid
, options
.fields
))
829 def update_provider_filters(self
):
830 """Propagates fields filters to providers."""
831 # As we reset the counters when updating the fields we can
832 # also clear the cache of old values.
834 for provider
in self
.providers
:
835 provider
.update_fields(self
._fields
_filter
)
839 for provider
in self
.providers
:
843 def fields_filter(self
):
844 return self
._fields
_filter
846 @fields_filter.setter
847 def fields_filter(self
, fields_filter
):
848 if fields_filter
!= self
._fields
_filter
:
849 self
._fields
_filter
= fields_filter
850 self
.update_provider_filters()
853 def pid_filter(self
):
854 return self
._pid
_filter
857 def pid_filter(self
, pid
):
858 if pid
!= self
._pid
_filter
:
859 self
._pid
_filter
= pid
861 for provider
in self
.providers
:
862 provider
.pid
= self
._pid
_filter
864 def get(self
, by_guest
=0):
865 """Returns a dict with field -> (value, delta to last value) of all
867 for provider
in self
.providers
:
868 new
= provider
.read(by_guest
=by_guest
)
869 for key
in new
if by_guest
else provider
.fields
:
870 oldval
= self
.values
.get(key
, (0, 0))[0]
871 newval
= new
.get(key
, 0)
872 newdelta
= newval
- oldval
873 self
.values
[key
] = (newval
, newdelta
)
876 def toggle_display_guests(self
, to_pid
):
877 """Toggle between collection of stats by individual event and by
880 Events reported by DebugfsProvider change when switching to/from
881 reading by guest values. Hence we have to remove the excess event
882 names from self.values.
885 if any(isinstance(ins
, TracepointProvider
) for ins
in self
.providers
):
888 for provider
in self
.providers
:
889 if isinstance(provider
, DebugfsProvider
):
890 for key
in provider
.fields
:
891 if key
in self
.values
.keys():
894 oldvals
= self
.values
.copy()
898 # Update oldval (see get())
903 MAX_GUEST_NAME_LEN
= 48
905 DEFAULT_REGEX
= r
'^[^\(]*$'
910 """Instruments curses to draw a nice text ui."""
911 def __init__(self
, stats
):
914 self
._delay
_initial
= 0.25
915 self
._delay
_regular
= DELAY_DEFAULT
916 self
._sorting
= SORT_DEFAULT
917 self
._display
_guests
= 0
920 """Initialises curses for later use. Based on curses.wrapper
921 implementation from the Python standard library."""
922 self
.screen
= curses
.initscr()
926 # The try/catch works around a minor bit of
927 # over-conscientiousness in the curses module, the error
928 # return from C start_color() is ignorable.
934 # Hide cursor in extra statement as some monochrome terminals
935 # might support hiding but not colors.
941 curses
.use_default_colors()
944 def __exit__(self
, *exception
):
945 """Resets the terminal to its normal state. Based on curses.wrapper
946 implementation from the Python standard library."""
948 self
.screen
.keypad(0)
953 def get_all_gnames(self
):
954 """Returns a list of (pid, gname) tuples of all running guests"""
957 child
= subprocess
.Popen(['ps', '-A', '--format', 'pid,args'],
958 stdout
=subprocess
.PIPE
)
961 for line
in child
.stdout
:
962 line
= line
.decode(ENCODING
).lstrip().split(' ', 1)
963 # perform a sanity check before calling the more expensive
964 # function to possibly extract the guest name
965 if ' -name ' in line
[1]:
966 res
.append((line
[0], self
.get_gname_from_pid(line
[0])))
971 def print_all_gnames(self
, row
):
972 """Print a list of all running guests along with their pids."""
973 self
.screen
.addstr(row
, 2, '%8s %-60s' %
974 ('Pid', 'Guest Name (fuzzy list, might be '
979 for line
in self
.get_all_gnames():
980 self
.screen
.addstr(row
, 2, '%8s %-60s' % (line
[0], line
[1]))
982 if row
>= self
.screen
.getmaxyx()[0]:
985 self
.screen
.addstr(row
+ 1, 2, 'Not available')
987 def get_pid_from_gname(self
, gname
):
988 """Fuzzy function to convert guest name to QEMU process pid.
990 Returns a list of potential pids, can be empty if no match found.
991 Throws an exception on processing errors.
995 for line
in self
.get_all_gnames():
997 pids
.append(int(line
[0]))
1002 def get_gname_from_pid(pid
):
1003 """Returns the guest name for a QEMU process pid.
1005 Extracts the guest name from the QEMU comma line by processing the
1006 '-name' option. Will also handle names specified out of sequence.
1011 line
= open('/proc/{}/cmdline'
1012 .format(pid
), 'r').read().split('\0')
1013 parms
= line
[line
.index('-name') + 1].split(',')
1015 # commas are escaped (i.e. ',,'), hence e.g. 'foo,bar' results
1016 # in # ['foo', '', 'bar'], which we revert here
1017 idx
= parms
.index('')
1018 parms
[idx
- 1] += ',' + parms
[idx
+ 1]
1019 del parms
[idx
:idx
+2]
1020 # the '-name' switch allows for two ways to specify the guest name,
1021 # where the plain name overrides the name specified via 'guest='
1026 if arg
[:6] == 'guest=':
1028 except (ValueError, IOError, IndexError):
1033 def update_drilldown(self
):
1034 """Sets or removes a filter that only allows fields without braces."""
1035 if not self
.stats
.fields_filter
:
1036 self
.stats
.fields_filter
= DEFAULT_REGEX
1038 elif self
.stats
.fields_filter
== DEFAULT_REGEX
:
1039 self
.stats
.fields_filter
= None
1041 def update_pid(self
, pid
):
1042 """Propagates pid selection to stats object."""
1043 self
.stats
.pid_filter
= pid
1045 def refresh_header(self
, pid
=None):
1046 """Refreshes the header."""
1048 pid
= self
.stats
.pid_filter
1050 gname
= self
.get_gname_from_pid(pid
)
1052 gname
= ('({})'.format(gname
[:MAX_GUEST_NAME_LEN
] + '...'
1053 if len(gname
) > MAX_GUEST_NAME_LEN
1056 self
.screen
.addstr(0, 0, 'kvm statistics - pid {0} {1}'
1057 .format(pid
, gname
), curses
.A_BOLD
)
1059 self
.screen
.addstr(0, 0, 'kvm statistics - summary', curses
.A_BOLD
)
1060 if self
.stats
.fields_filter
and self
.stats
.fields_filter \
1062 regex
= self
.stats
.fields_filter
1063 if len(regex
) > MAX_REGEX_LEN
:
1064 regex
= regex
[:MAX_REGEX_LEN
] + '...'
1065 self
.screen
.addstr(1, 17, 'regex filter: {0}'.format(regex
))
1066 if self
._display
_guests
:
1067 col_name
= 'Guest Name'
1070 self
.screen
.addstr(2, 1, '%-40s %10s%7s %8s' %
1071 (col_name
, 'Total', '%Total', 'CurAvg/s'),
1073 self
.screen
.addstr(4, 1, 'Collecting data...')
1074 self
.screen
.refresh()
1076 def refresh_body(self
, sleeptime
):
1078 self
.screen
.move(row
, 0)
1079 self
.screen
.clrtobot()
1080 stats
= self
.stats
.get(self
._display
_guests
)
1083 # sort by current events if available
1085 return (-stats
[x
][1], -stats
[x
][0])
1087 return (0, -stats
[x
][0])
1091 return (0, -stats
[x
][0])
1093 for val
in stats
.values():
1095 if self
._sorting
== SORT_DEFAULT
:
1096 sortkey
= sortCurAvg
1099 for key
in sorted(stats
.keys(), key
=sortkey
):
1101 if row
>= self
.screen
.getmaxyx()[0]:
1104 if not values
[0] and not values
[1]:
1106 if values
[0] is not None:
1107 cur
= int(round(values
[1] / sleeptime
)) if values
[1] else ''
1108 if self
._display
_guests
:
1109 key
= self
.get_gname_from_pid(key
)
1110 self
.screen
.addstr(row
, 1, '%-40s %10d%7.1f %8s' %
1111 (key
, values
[0], values
[0] * 100 / total
,
1115 self
.screen
.addstr(4, 1, 'No matching events reported yet')
1116 self
.screen
.refresh()
1118 def show_msg(self
, text
):
1119 """Display message centered text and exit on key press"""
1120 hint
= 'Press any key to continue'
1123 (x
, term_width
) = self
.screen
.getmaxyx()
1126 start
= (term_width
- len(line
)) / 2
1127 self
.screen
.addstr(row
, start
, line
)
1129 self
.screen
.addstr(row
+ 1, (term_width
- len(hint
)) / 2, hint
,
1131 self
.screen
.getkey()
1133 def show_help_interactive(self
):
1134 """Display help with list of interactive commands"""
1135 msg
= (' b toggle events by guests (debugfs only, honors'
1138 ' f filter by regular expression',
1139 ' g filter by guest name',
1140 ' h display interactive commands reference',
1141 ' o toggle sorting order (Total vs CurAvg/s)',
1145 ' s set update interval',
1146 ' x toggle reporting of stats for individual child trace'
1148 'Any other key refreshes statistics immediately')
1151 self
.screen
.addstr(0, 0, "Interactive commands reference",
1153 self
.screen
.addstr(2, 0, "Press any key to exit", curses
.A_STANDOUT
)
1156 self
.screen
.addstr(row
, 0, line
)
1158 self
.screen
.getkey()
1159 self
.refresh_header()
1161 def show_filter_selection(self
):
1162 """Draws filter selection mask.
1164 Asks for a valid regex and sets the fields filter accordingly.
1169 self
.screen
.addstr(0, 0,
1170 "Show statistics for events matching a regex.",
1172 self
.screen
.addstr(2, 0,
1173 "Current regex: {0}"
1174 .format(self
.stats
.fields_filter
))
1175 self
.screen
.addstr(3, 0, "New regex: ")
1177 regex
= self
.screen
.getstr().decode(ENCODING
)
1180 self
.stats
.fields_filter
= DEFAULT_REGEX
1181 self
.refresh_header()
1185 self
.stats
.fields_filter
= regex
1186 self
.refresh_header()
1191 def show_vm_selection_by_pid(self
):
1192 """Draws PID selection mask.
1194 Asks for a pid until a valid pid or 0 has been entered.
1200 self
.screen
.addstr(0, 0,
1201 'Show statistics for specific pid.',
1203 self
.screen
.addstr(1, 0,
1204 'This might limit the shown data to the trace '
1206 self
.screen
.addstr(5, 0, msg
)
1207 self
.print_all_gnames(7)
1210 self
.screen
.addstr(3, 0, "Pid [0 or pid]: ")
1211 pid
= self
.screen
.getstr().decode(ENCODING
)
1217 if pid
!= 0 and not os
.path
.isdir(os
.path
.join('/proc/',
1219 msg
= '"' + str(pid
) + '": Not a running process'
1223 self
.refresh_header(pid
)
1224 self
.update_pid(pid
)
1227 msg
= '"' + str(pid
) + '": Not a valid pid'
1229 def show_set_update_interval(self
):
1230 """Draws update interval selection mask."""
1234 self
.screen
.addstr(0, 0, 'Set update interval (defaults to %fs).' %
1235 DELAY_DEFAULT
, curses
.A_BOLD
)
1236 self
.screen
.addstr(4, 0, msg
)
1237 self
.screen
.addstr(2, 0, 'Change delay from %.1fs to ' %
1238 self
._delay
_regular
)
1240 val
= self
.screen
.getstr().decode(ENCODING
)
1247 msg
= '"' + str(val
) + '": Value must be >=0.1'
1250 msg
= '"' + str(val
) + '": Value must be <=25.5'
1253 delay
= DELAY_DEFAULT
1254 self
._delay
_regular
= delay
1258 msg
= '"' + str(val
) + '": Invalid value'
1259 self
.refresh_header()
1261 def show_vm_selection_by_guest_name(self
):
1262 """Draws guest selection mask.
1264 Asks for a guest name until a valid guest name or '' is entered.
1270 self
.screen
.addstr(0, 0,
1271 'Show statistics for specific guest.',
1273 self
.screen
.addstr(1, 0,
1274 'This might limit the shown data to the trace '
1276 self
.screen
.addstr(5, 0, msg
)
1277 self
.print_all_gnames(7)
1279 self
.screen
.addstr(3, 0, "Guest [ENTER or guest]: ")
1280 gname
= self
.screen
.getstr().decode(ENCODING
)
1284 self
.refresh_header(0)
1290 pids
= self
.get_pid_from_gname(gname
)
1292 msg
= '"' + gname
+ '": Internal error while searching, ' \
1293 'use pid filter instead'
1296 msg
= '"' + gname
+ '": Not an active guest'
1299 msg
= '"' + gname
+ '": Multiple matches found, use pid ' \
1302 self
.refresh_header(pids
[0])
1303 self
.update_pid(pids
[0])
1306 def show_stats(self
):
1307 """Refreshes the screen and processes user input."""
1308 sleeptime
= self
._delay
_initial
1309 self
.refresh_header()
1310 start
= 0.0 # result based on init value never appears on screen
1312 self
.refresh_body(time
.time() - start
)
1313 curses
.halfdelay(int(sleeptime
* 10))
1315 sleeptime
= self
._delay
_regular
1317 char
= self
.screen
.getkey()
1319 self
._display
_guests
= not self
._display
_guests
1320 if self
.stats
.toggle_display_guests(self
._display
_guests
):
1321 self
.show_msg(['Command not available with tracepoints'
1322 ' enabled', 'Restart with debugfs only '
1323 '(see option \'-d\') and try again!'])
1324 self
._display
_guests
= not self
._display
_guests
1325 self
.refresh_header()
1327 self
.stats
.fields_filter
= DEFAULT_REGEX
1328 self
.refresh_header(0)
1332 self
.show_filter_selection()
1334 sleeptime
= self
._delay
_initial
1337 self
.show_vm_selection_by_guest_name()
1339 sleeptime
= self
._delay
_initial
1341 self
.show_help_interactive()
1343 self
._sorting
= not self
._sorting
1346 self
.show_vm_selection_by_pid()
1348 sleeptime
= self
._delay
_initial
1355 self
.show_set_update_interval()
1357 sleeptime
= self
._delay
_initial
1359 self
.update_drilldown()
1360 # prevents display of current values on next refresh
1362 except KeyboardInterrupt:
1364 except curses
.error
:
1369 """Prints statistics in a key, value format."""
1374 for key
in sorted(s
.keys()):
1376 print('%-42s%10d%10d' % (key
, values
[0], values
[1]))
1377 except KeyboardInterrupt:
1382 """Prints statistics as reiterating key block, multiple value blocks."""
1383 keys
= sorted(stats
.get().keys())
1393 print(' %9d' % s
[k
][1], end
=' ')
1400 if line
% banner_repeat
== 0:
1404 except KeyboardInterrupt:
1409 """Returns processed program arguments."""
1410 description_text
= """
1411 This script displays various statistics about VMs running under KVM.
1412 The statistics are gathered from the KVM debugfs entries and / or the
1413 currently available perf traces.
1415 The monitoring takes additional cpu cycles and might affect the VM's
1423 - /proc/sys/kernel/perf_event_paranoid < 1 if user has no
1424 CAP_SYS_ADMIN and perf events are used.
1425 - CAP_SYS_RESOURCE if the hard limit is not high enough to allow
1426 the large number of files that are possibly opened.
1428 Interactive Commands:
1429 b toggle events by guests (debugfs only, honors filters)
1431 f filter by regular expression
1432 g filter by guest name
1433 h display interactive commands reference
1434 o toggle sorting order (Total vs CurAvg/s)
1438 s set update interval
1439 x toggle reporting of stats for individual child trace events
1440 Press any other key to refresh statistics immediately.
1441 """ % (PATH_DEBUGFS_KVM
, PATH_DEBUGFS_TRACING
)
1443 class PlainHelpFormatter(optparse
.IndentedHelpFormatter
):
1444 def format_description(self
, description
):
1446 return description
+ "\n"
1450 def cb_guest_to_pid(option
, opt
, val
, parser
):
1452 pids
= Tui
.get_pid_from_gname(val
)
1454 raise optparse
.OptionValueError('Error while searching for guest '
1455 '"{}", use "-p" to specify a pid '
1456 'instead'.format(val
))
1458 raise optparse
.OptionValueError('No guest by the name "{}" '
1459 'found'.format(val
))
1461 raise optparse
.OptionValueError('Multiple processes found (pids: '
1462 '{}) - use "-p" to specify a pid '
1463 'instead'.format(" ".join(pids
)))
1464 parser
.values
.pid
= pids
[0]
1466 optparser
= optparse
.OptionParser(description
=description_text
,
1467 formatter
=PlainHelpFormatter())
1468 optparser
.add_option('-1', '--once', '--batch',
1469 action
='store_true',
1472 help='run in batch mode for one second',
1474 optparser
.add_option('-i', '--debugfs-include-past',
1475 action
='store_true',
1477 dest
='dbgfs_include_past',
1478 help='include all available data on past events for '
1481 optparser
.add_option('-l', '--log',
1482 action
='store_true',
1485 help='run in logging mode (like vmstat)',
1487 optparser
.add_option('-t', '--tracepoints',
1488 action
='store_true',
1491 help='retrieve statistics from tracepoints',
1493 optparser
.add_option('-d', '--debugfs',
1494 action
='store_true',
1497 help='retrieve statistics from debugfs',
1499 optparser
.add_option('-f', '--fields',
1501 default
=DEFAULT_REGEX
,
1503 help='''fields to display (regex)
1504 "-f help" for a list of available events''',
1506 optparser
.add_option('-p', '--pid',
1511 help='restrict statistics to pid',
1513 optparser
.add_option('-g', '--guest',
1518 help='restrict statistics to guest by name',
1519 callback
=cb_guest_to_pid
,
1521 (options
, _
) = optparser
.parse_args(sys
.argv
)
1525 def check_access(options
):
1526 """Exits if the current user can't access all needed directories."""
1527 if not os
.path
.exists('/sys/kernel/debug'):
1528 sys
.stderr
.write('Please enable CONFIG_DEBUG_FS in your kernel.')
1531 if not os
.path
.exists(PATH_DEBUGFS_KVM
):
1532 sys
.stderr
.write("Please make sure, that debugfs is mounted and "
1533 "readable by the current user:\n"
1534 "('mount -t debugfs debugfs /sys/kernel/debug')\n"
1535 "Also ensure, that the kvm modules are loaded.\n")
1538 if not os
.path
.exists(PATH_DEBUGFS_TRACING
) and (options
.tracepoints
or
1539 not options
.debugfs
):
1540 sys
.stderr
.write("Please enable CONFIG_TRACING in your kernel "
1541 "when using the option -t (default).\n"
1542 "If it is enabled, make {0} readable by the "
1544 .format(PATH_DEBUGFS_TRACING
))
1545 if options
.tracepoints
:
1548 sys
.stderr
.write("Falling back to debugfs statistics!\n")
1549 options
.debugfs
= True
1556 options
= get_options()
1557 options
= check_access(options
)
1559 if (options
.pid
> 0 and
1560 not os
.path
.isdir(os
.path
.join('/proc/',
1561 str(options
.pid
)))):
1562 sys
.stderr
.write('Did you use a (unsupported) tid instead of a pid?\n')
1563 sys
.exit('Specified pid does not exist.')
1565 stats
= Stats(options
)
1567 if options
.fields
== "help":
1570 for key
in s
.keys():
1571 if key
.find('(') != -1:
1572 key
= key
[0:key
.find('(')]
1573 if event_list
.find('\n' + key
+ '\n') == -1:
1574 event_list
+= key
+ '\n'
1575 sys
.stdout
.write(event_list
)
1580 elif not options
.once
:
1581 with
Tui(stats
) as tui
:
1586 if __name__
== "__main__":