From 49ebd26734d492cc4189b97704052780b3641854 Mon Sep 17 00:00:00 2001

From: "Danilo C. L. de Paula" <ddepaula@redhat.com>

Date: Mon, 16 Jan 2017 11:52:49 +0100

Subject: Revert "kvm_stat: Remove"

RH-Author: ddepaula <ddepaula@redhat.com>

Message-id: <1479302806-10135-2-git-send-email-ddepaula@redhat.com>

Patchwork-id: 72851

O-Subject: [RHEV-7.4 qemu-kvm-rhev PATCH v3 1/3] Revert "kvm_stat: Remove"

Bugzilla: 1389238

RH-Acked-by: John Snow <jsnow@redhat.com>

RH-Acked-by: David Hildenbrand <david@redhat.com>

RH-Acked-by: Miroslav Rezanina <mrezanin@redhat.com>

kvm_stat script was removed in QEMU 2.7.0 as it become part of kernel

tree. However kvm_stat is shipped in qemu-kvm-tools package in RHEL.

This reverts commit 60b412dd18362bd4ddc44ba7022aacb6af074b5d.

Signed-off-by: Danilo Cesar Lemes de Paula <ddepaula@redhat.com>

Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>

Merged patches (2.11.0):

- beffa30342 tools/kvm_stat: hide cursor

- 98cf56caaa tools/kvm_stat: catch curses exceptions only

- dada85e20a tools/kvm_stat: handle SIGINT in log and batch modes

- 8654f68785 tools/kvm_stat: fix misc glitches

- d4525d7460 tools/kvm_stat: fix trace setup glitch on field updates in TracepointProvider

- 5f41d9716a tools/kvm_stat: full PEP8 compliance

- 5bf653923c tools/kvm_stat: reduce perceived idle time on filter updates

- 2ef292f12d tools/kvm_stat: document list of interactive commands

- 3e1d2fc34c tools/kvm_stat: display guest name when using pid filter

- 66f2e8203e tools/kvm_stat: remove pid filter on empty input

- 05cc1c1aab tools/kvm_stat: print error messages on faulty pid filter input

- a0c6451760 tools/kvm_stat: display regex when set to non-default

- 3c7dae7507 tools/kvm_stat: remove regex filter on empty input

- 8b7b31fc24 tools/kvm_stat: add option '--guest'

- 38362f9d75 tools/kvm_stat: add interactive command 'c'

- 243d90a041 tools/kvm_stat: add interactive command 'r'

- 4f80c9081b tools/kvm_stat: add '%Total' column

- e21fb4a96e tools/kvm_stat: fix typo

- 7bc419ee18 tools/kvm_stat: fix event counts display for interrupted intervals

- d54183dd4b tools/kvm_stat: fix undue use of initial sleeptime

- 6514729674 tools/kvm_stat: remove unnecessary header redraws

- c4f941df75 tools/kvm_stat: simplify line print logic

- 35c050e4fd tools/kvm_stat: removed unused function

- 92d06e843c tools/kvm_stat: remove extra statement

- d0ced131bf tools/kvm_stat: simplify initializers

- 1dbc0659ac tools/kvm_stat: move functions to corresponding classes

- bf53d77372 tools/kvm_stat: show cursor in selection screens

- 6b557dc235 tools/kvm_stat: display message indicating lack of events

- 7f50a8be62 tools/kvm_stat: make heading look a bit more like 'top'

- 8ba2fd89d1 tools/kvm_stat: rename 'Current' column to 'CurAvg/s'

- 95b5c46145 tools/kvm_stat: add new interactive command 'h'

- 25c56e3212 tools/kvm_stat: add new interactive command 's'

- 55f7ed9b2c tools/kvm_stat: add new interactive command 'o'

- 53a1267b00 tools/kvm_stat: display guest list in pid/guest selection screens

- 554fa10df5 tools/kvm_stat: display guest list in pid/guest selection screens

- 72f660ddfc tools/kvm_stat: add new command line switch '-i'

- 17165a0bc8 tools/kvm_stat: add new interactive command 'b'

- ac6ba9a14b tools/kvm_stat: use variables instead of hard paths in help output

- 592b801e5c tools/kvm_stat: add '-f help' to get the available event list

- 283aa25f75 tools/kvm_stat: fix command line option '-g'

Merged patches (2.9.0):

- 1e69b1b Include kvm_stat in qemu-kvm.spec

- 7fcfc94 tools: kvm_stat: Powerpc related fixes

- 7f89136 tools: kvm_stat: Introduce pid monitoring

- c728a6b tools: kvm_stat: Add comments

- 27fb856 Package man page of "kvm_stat" tool

(cherry picked from commit d4a8e35b84072816c79e23f5d0a69a2145217004)

(cherry picked from commit e0425f69f136a05a59ee5cb7022409ed2be94a0b)

(cherry picked from commit 57e760aee8b28f3b2c6b9f3aad0d2b916dd13595)

(cherry picked from commit d711afa1b8ef8aba1397158626816008936ed0d6)

(cherry picked from commit 8ceca7bebce67440898c22d058047daa8ec37031)

---

 Makefile                      |    8 +

 redhat/qemu-kvm.spec.template |    7 +-

 scripts/kvm/kvm_stat          | 1585 +++++++++++++++++++++++++++++++++++++++++

 scripts/kvm/kvm_stat.texi     |  104 +++

 4 files changed, 1703 insertions(+), 1 deletion(-)

 create mode 100755 scripts/kvm/kvm_stat

 create mode 100644 scripts/kvm/kvm_stat.texi

diff --git a/Makefile b/Makefile

index 89ba4c5..2ffac2b 100644

--- a/Makefile

+++ b/Makefile

@@ -354,6 +354,9 @@ DOCS=qemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8

 DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7

 DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7

 DOCS+=docs/qemu-block-drivers.7

+ifdef CONFIG_LINUX

+DOCS+=kvm_stat.1

+endif

 ifdef CONFIG_VIRTFS

 DOCS+=fsdev/virtfs-proxy-helper.1

 endif

@@ -955,6 +958,11 @@ html: qemu-doc.html docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html

 info: qemu-doc.info docs/interop/qemu-qmp-ref.info docs/interop/qemu-ga-ref.info

 pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf

 txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt

+kvm_stat.1: scripts/kvm/kvm_stat.texi

+	$(call quiet-command, \

+	  perl -Ww -- $(SRC_PATH)/scripts/texi2pod.pl $< kvm_stat.pod && \

+	  $(POD2MAN) --section=1 --center=" " --release=" " kvm_stat.pod > $@, \

+	  "  GEN   $@")

 qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \

 	qemu-img.texi qemu-nbd.texi qemu-options.texi qemu-option-trace.texi \

diff --git a/scripts/kvm/kvm_stat b/scripts/kvm/kvm_stat

new file mode 100755

index 0000000..c74a9a0

--- /dev/null

+++ b/scripts/kvm/kvm_stat

@@ -0,0 +1,1585 @@

+#!/usr/bin/python

+#

+# top-like utility for displaying kvm statistics

+#

+# Copyright 2006-2008 Qumranet Technologies

+# Copyright 2008-2011 Red Hat, Inc.

+#

+# Authors:

+#  Avi Kivity <avi@redhat.com>

+#

+# This work is licensed under the terms of the GNU GPL, version 2.  See

+# the COPYING file in the top-level directory.

+"""The kvm_stat module outputs statistics about running KVM VMs

+

+Three different ways of output formatting are available:

+- as a top-like text ui

+- in a key -> value format

+- in an all keys, all values format

+

+The data is sampled from the KVM's debugfs entries and its perf events.

+"""

+

+import curses

+import sys

+import os

+import time

+import optparse

+import ctypes

+import fcntl

+import resource

+import struct

+import re

+import subprocess

+from collections import defaultdict

+

+VMX_EXIT_REASONS = {

+    'EXCEPTION_NMI':        0,

+    'EXTERNAL_INTERRUPT':   1,

+    'TRIPLE_FAULT':         2,

+    'PENDING_INTERRUPT':    7,

+    'NMI_WINDOW':           8,

+    'TASK_SWITCH':          9,

+    'CPUID':                10,

+    'HLT':                  12,

+    'INVLPG':               14,

+    'RDPMC':                15,

+    'RDTSC':                16,

+    'VMCALL':               18,

+    'VMCLEAR':              19,

+    'VMLAUNCH':             20,

+    'VMPTRLD':              21,

+    'VMPTRST':              22,

+    'VMREAD':               23,

+    'VMRESUME':             24,

+    'VMWRITE':              25,

+    'VMOFF':                26,

+    'VMON':                 27,

+    'CR_ACCESS':            28,

+    'DR_ACCESS':            29,

+    'IO_INSTRUCTION':       30,

+    'MSR_READ':             31,

+    'MSR_WRITE':            32,

+    'INVALID_STATE':        33,

+    'MWAIT_INSTRUCTION':    36,

+    'MONITOR_INSTRUCTION':  39,

+    'PAUSE_INSTRUCTION':    40,

+    'MCE_DURING_VMENTRY':   41,

+    'TPR_BELOW_THRESHOLD':  43,

+    'APIC_ACCESS':          44,

+    'EPT_VIOLATION':        48,

+    'EPT_MISCONFIG':        49,

+    'WBINVD':               54,

+    'XSETBV':               55,

+    'APIC_WRITE':           56,

+    'INVPCID':              58,

+}

+

+SVM_EXIT_REASONS = {

+    'READ_CR0':       0x000,

+    'READ_CR3':       0x003,

+    'READ_CR4':       0x004,

+    'READ_CR8':       0x008,

+    'WRITE_CR0':      0x010,

+    'WRITE_CR3':      0x013,

+    'WRITE_CR4':      0x014,

+    'WRITE_CR8':      0x018,

+    'READ_DR0':       0x020,

+    'READ_DR1':       0x021,

+    'READ_DR2':       0x022,

+    'READ_DR3':       0x023,

+    'READ_DR4':       0x024,

+    'READ_DR5':       0x025,

+    'READ_DR6':       0x026,

+    'READ_DR7':       0x027,

+    'WRITE_DR0':      0x030,

+    'WRITE_DR1':      0x031,

+    'WRITE_DR2':      0x032,

+    'WRITE_DR3':      0x033,

+    'WRITE_DR4':      0x034,

+    'WRITE_DR5':      0x035,

+    'WRITE_DR6':      0x036,

+    'WRITE_DR7':      0x037,

+    'EXCP_BASE':      0x040,

+    'INTR':           0x060,

+    'NMI':            0x061,

+    'SMI':            0x062,

+    'INIT':           0x063,

+    'VINTR':          0x064,

+    'CR0_SEL_WRITE':  0x065,

+    'IDTR_READ':      0x066,

+    'GDTR_READ':      0x067,

+    'LDTR_READ':      0x068,

+    'TR_READ':        0x069,

+    'IDTR_WRITE':     0x06a,

+    'GDTR_WRITE':     0x06b,

+    'LDTR_WRITE':     0x06c,

+    'TR_WRITE':       0x06d,

+    'RDTSC':          0x06e,

+    'RDPMC':          0x06f,

+    'PUSHF':          0x070,

+    'POPF':           0x071,

+    'CPUID':          0x072,

+    'RSM':            0x073,

+    'IRET':           0x074,

+    'SWINT':          0x075,

+    'INVD':           0x076,

+    'PAUSE':          0x077,

+    'HLT':            0x078,

+    'INVLPG':         0x079,

+    'INVLPGA':        0x07a,

+    'IOIO':           0x07b,

+    'MSR':            0x07c,

+    'TASK_SWITCH':    0x07d,

+    'FERR_FREEZE':    0x07e,

+    'SHUTDOWN':       0x07f,

+    'VMRUN':          0x080,

+    'VMMCALL':        0x081,

+    'VMLOAD':         0x082,

+    'VMSAVE':         0x083,

+    'STGI':           0x084,

+    'CLGI':           0x085,

+    'SKINIT':         0x086,

+    'RDTSCP':         0x087,

+    'ICEBP':          0x088,

+    'WBINVD':         0x089,

+    'MONITOR':        0x08a,

+    'MWAIT':          0x08b,

+    'MWAIT_COND':     0x08c,

+    'XSETBV':         0x08d,

+    'NPF':            0x400,

+}

+

+# EC definition of HSR (from arch/arm64/include/asm/kvm_arm.h)

+AARCH64_EXIT_REASONS = {

+    'UNKNOWN':      0x00,

+    'WFI':          0x01,

+    'CP15_32':      0x03,

+    'CP15_64':      0x04,

+    'CP14_MR':      0x05,

+    'CP14_LS':      0x06,

+    'FP_ASIMD':     0x07,

+    'CP10_ID':      0x08,

+    'CP14_64':      0x0C,

+    'ILL_ISS':      0x0E,

+    'SVC32':        0x11,

+    'HVC32':        0x12,

+    'SMC32':        0x13,

+    'SVC64':        0x15,

+    'HVC64':        0x16,

+    'SMC64':        0x17,

+    'SYS64':        0x18,

+    'IABT':         0x20,

+    'IABT_HYP':     0x21,

+    'PC_ALIGN':     0x22,

+    'DABT':         0x24,

+    'DABT_HYP':     0x25,

+    'SP_ALIGN':     0x26,

+    'FP_EXC32':     0x28,

+    'FP_EXC64':     0x2C,

+    'SERROR':       0x2F,

+    'BREAKPT':      0x30,

+    'BREAKPT_HYP':  0x31,

+    'SOFTSTP':      0x32,

+    'SOFTSTP_HYP':  0x33,

+    'WATCHPT':      0x34,

+    'WATCHPT_HYP':  0x35,

+    'BKPT32':       0x38,

+    'VECTOR32':     0x3A,

+    'BRK64':        0x3C,

+}

+

+# From include/uapi/linux/kvm.h, KVM_EXIT_xxx

+USERSPACE_EXIT_REASONS = {

+    'UNKNOWN':          0,

+    'EXCEPTION':        1,

+    'IO':               2,

+    'HYPERCALL':        3,

+    'DEBUG':            4,

+    'HLT':              5,

+    'MMIO':             6,

+    'IRQ_WINDOW_OPEN':  7,

+    'SHUTDOWN':         8,

+    'FAIL_ENTRY':       9,

+    'INTR':             10,

+    'SET_TPR':          11,

+    'TPR_ACCESS':       12,

+    'S390_SIEIC':       13,

+    'S390_RESET':       14,

+    'DCR':              15,

+    'NMI':              16,

+    'INTERNAL_ERROR':   17,

+    'OSI':              18,

+    'PAPR_HCALL':       19,

+    'S390_UCONTROL':    20,

+    'WATCHDOG':         21,

+    'S390_TSCH':        22,

+    'EPR':              23,

+    'SYSTEM_EVENT':     24,

+}

+

+IOCTL_NUMBERS = {

+    'SET_FILTER':  0x40082406,

+    'ENABLE':      0x00002400,

+    'DISABLE':     0x00002401,

+    'RESET':       0x00002403,

+}

+

+

+class Arch(object):

+    """Encapsulates global architecture specific data.

+

+    Contains the performance event open syscall and ioctl numbers, as

+    well as the VM exit reasons for the architecture it runs on.

+

+    """

+    @staticmethod

+    def get_arch():

+        machine = os.uname()[4]

+

+        if machine.startswith('ppc'):

+            return ArchPPC()

+        elif machine.startswith('aarch64'):

+            return ArchA64()

+        elif machine.startswith('s390'):

+            return ArchS390()

+        else:

+            # X86_64

+            for line in open('/proc/cpuinfo'):

+                if not line.startswith('flags'):

+                    continue

+

+                flags = line.split()

+                if 'vmx' in flags:

+                    return ArchX86(VMX_EXIT_REASONS)

+                if 'svm' in flags:

+                    return ArchX86(SVM_EXIT_REASONS)

+                return

+

+

+class ArchX86(Arch):

+    def __init__(self, exit_reasons):

+        self.sc_perf_evt_open = 298

+        self.ioctl_numbers = IOCTL_NUMBERS

+        self.exit_reasons = exit_reasons

+

+

+class ArchPPC(Arch):

+    def __init__(self):

+        self.sc_perf_evt_open = 319

+        self.ioctl_numbers = IOCTL_NUMBERS

+        self.ioctl_numbers['ENABLE'] = 0x20002400

+        self.ioctl_numbers['DISABLE'] = 0x20002401

+        self.ioctl_numbers['RESET'] = 0x20002403

+

+        # PPC comes in 32 and 64 bit and some generated ioctl

+        # numbers depend on the wordsize.

+        char_ptr_size = ctypes.sizeof(ctypes.c_char_p)

+        self.ioctl_numbers['SET_FILTER'] = 0x80002406 | char_ptr_size << 16

+        self.exit_reasons = {}

+

+

+class ArchA64(Arch):

+    def __init__(self):

+        self.sc_perf_evt_open = 241

+        self.ioctl_numbers = IOCTL_NUMBERS

+        self.exit_reasons = AARCH64_EXIT_REASONS

+

+

+class ArchS390(Arch):

+    def __init__(self):

+        self.sc_perf_evt_open = 331

+        self.ioctl_numbers = IOCTL_NUMBERS

+        self.exit_reasons = None

+

+ARCH = Arch.get_arch()

+

+

+class perf_event_attr(ctypes.Structure):

+    """Struct that holds the necessary data to set up a trace event.

+

+    For an extensive explanation see perf_event_open(2) and

+    include/uapi/linux/perf_event.h, struct perf_event_attr

+

+    All fields that are not initialized in the constructor are 0.

+

+    """

+    _fields_ = [('type', ctypes.c_uint32),

+                ('size', ctypes.c_uint32),

+                ('config', ctypes.c_uint64),

+                ('sample_freq', ctypes.c_uint64),

+                ('sample_type', ctypes.c_uint64),

+                ('read_format', ctypes.c_uint64),

+                ('flags', ctypes.c_uint64),

+                ('wakeup_events', ctypes.c_uint32),

+                ('bp_type', ctypes.c_uint32),

+                ('bp_addr', ctypes.c_uint64),

+                ('bp_len', ctypes.c_uint64),

+                ]

+

+    def __init__(self):

+        super(self.__class__, self).__init__()

+        self.type = PERF_TYPE_TRACEPOINT

+        self.size = ctypes.sizeof(self)

+        self.read_format = PERF_FORMAT_GROUP

+

+

+PERF_TYPE_TRACEPOINT = 2

+PERF_FORMAT_GROUP = 1 << 3

+

+PATH_DEBUGFS_TRACING = '/sys/kernel/debug/tracing'

+PATH_DEBUGFS_KVM = '/sys/kernel/debug/kvm'

+

+

+class Group(object):

+    """Represents a perf event group."""

+

+    def __init__(self):

+        self.events = []

+

+    def add_event(self, event):

+        self.events.append(event)

+

+    def read(self):

+        """Returns a dict with 'event name: value' for all events in the

+        group.

+

+        Values are read by reading from the file descriptor of the

+        event that is the group leader. See perf_event_open(2) for

+        details.

+

+        Read format for the used event configuration is:

+        struct read_format {

+            u64 nr; /* The number of events */

+            struct {

+                u64 value; /* The value of the event */

+            } values[nr];

+        };

+

+        """

+        length = 8 * (1 + len(self.events))

+        read_format = 'xxxxxxxx' + 'Q' * len(self.events)

+        return dict(zip([event.name for event in self.events],

+                        struct.unpack(read_format,

+                                      os.read(self.events[0].fd, length))))

+

+

+class Event(object):

+    """Represents a performance event and manages its life cycle."""

+    def __init__(self, name, group, trace_cpu, trace_pid, trace_point,

+                 trace_filter, trace_set='kvm'):

+        self.libc = ctypes.CDLL('libc.so.6', use_errno=True)

+        self.syscall = self.libc.syscall

+        self.name = name

+        self.fd = None

+        self.setup_event(group, trace_cpu, trace_pid, trace_point,

+                         trace_filter, trace_set)

+

+    def __del__(self):

+        """Closes the event's file descriptor.

+

+        As no python file object was created for the file descriptor,

+        python will not reference count the descriptor and will not

+        close it itself automatically, so we do it.

+

+        """

+        if self.fd:

+            os.close(self.fd)

+

+    def perf_event_open(self, attr, pid, cpu, group_fd, flags):

+        """Wrapper for the sys_perf_evt_open() syscall.

+

+        Used to set up performance events, returns a file descriptor or -1

+        on error.

+

+        Attributes are:

+        - syscall number

+        - struct perf_event_attr *

+        - pid or -1 to monitor all pids

+        - cpu number or -1 to monitor all cpus

+        - The file descriptor of the group leader or -1 to create a group.

+        - flags

+

+        """

+        return self.syscall(ARCH.sc_perf_evt_open, ctypes.pointer(attr),

+                            ctypes.c_int(pid), ctypes.c_int(cpu),

+                            ctypes.c_int(group_fd), ctypes.c_long(flags))

+

+    def setup_event_attribute(self, trace_set, trace_point):

+        """Returns an initialized ctype perf_event_attr struct."""

+

+        id_path = os.path.join(PATH_DEBUGFS_TRACING, 'events', trace_set,

+                               trace_point, 'id')

+

+        event_attr = perf_event_attr()

+        event_attr.config = int(open(id_path).read())

+        return event_attr

+

+    def setup_event(self, group, trace_cpu, trace_pid, trace_point,

+                    trace_filter, trace_set):

+        """Sets up the perf event in Linux.

+

+        Issues the syscall to register the event in the kernel and

+        then sets the optional filter.

+

+        """

+

+        event_attr = self.setup_event_attribute(trace_set, trace_point)

+

+        # First event will be group leader.

+        group_leader = -1

+

+        # All others have to pass the leader's descriptor instead.

+        if group.events:

+            group_leader = group.events[0].fd

+

+        fd = self.perf_event_open(event_attr, trace_pid,

+                                  trace_cpu, group_leader, 0)

+        if fd == -1:

+            err = ctypes.get_errno()

+            raise OSError(err, os.strerror(err),

+                          'while calling sys_perf_event_open().')

+

+        if trace_filter:

+            fcntl.ioctl(fd, ARCH.ioctl_numbers['SET_FILTER'],

+                        trace_filter)

+

+        self.fd = fd

+

+    def enable(self):

+        """Enables the trace event in the kernel.

+

+        Enabling the group leader makes reading counters from it and the

+        events under it possible.

+

+        """

+        fcntl.ioctl(self.fd, ARCH.ioctl_numbers['ENABLE'], 0)

+

+    def disable(self):

+        """Disables the trace event in the kernel.

+

+        Disabling the group leader makes reading all counters under it

+        impossible.

+

+        """

+        fcntl.ioctl(self.fd, ARCH.ioctl_numbers['DISABLE'], 0)

+

+    def reset(self):

+        """Resets the count of the trace event in the kernel."""

+        fcntl.ioctl(self.fd, ARCH.ioctl_numbers['RESET'], 0)

+

+

+class Provider(object):

+    """Encapsulates functionalities used by all providers."""

+    @staticmethod

+    def is_field_wanted(fields_filter, field):

+        """Indicate whether field is valid according to fields_filter."""

+        if not fields_filter or fields_filter == "help":

+            return True

+        return re.match(fields_filter, field) is not None

+

+    @staticmethod

+    def walkdir(path):

+        """Returns os.walk() data for specified directory.

+

+        As it is only a wrapper it returns the same 3-tuple of (dirpath,

+        dirnames, filenames).

+        """

+        return next(os.walk(path))

+

+

+class TracepointProvider(Provider):

+    """Data provider for the stats class.

+

+    Manages the events/groups from which it acquires its data.

+

+    """

+    def __init__(self, pid, fields_filter):

+        self.group_leaders = []

+        self.filters = self.get_filters()

+        self.update_fields(fields_filter)

+        self.pid = pid

+

+    @staticmethod

+    def get_filters():

+        """Returns a dict of trace events, their filter ids and

+        the values that can be filtered.

+

+        Trace events can be filtered for special values by setting a

+        filter string via an ioctl. The string normally has the format

+        identifier==value. For each filter a new event will be created, to

+        be able to distinguish the events.

+

+        """

+        filters = {}

+        filters['kvm_userspace_exit'] = ('reason', USERSPACE_EXIT_REASONS)

+        if ARCH.exit_reasons:

+            filters['kvm_exit'] = ('exit_reason', ARCH.exit_reasons)

+        return filters

+

+    def get_available_fields(self):

+        """Returns a list of available event's of format 'event name(filter

+        name)'.

+

+        All available events have directories under

+        /sys/kernel/debug/tracing/events/ which export information

+        about the specific event. Therefore, listing the dirs gives us

+        a list of all available events.

+

+        Some events like the vm exit reasons can be filtered for

+        specific values. To take account for that, the routine below

+        creates special fields with the following format:

+        event name(filter name)

+

+        """

+        path = os.path.join(PATH_DEBUGFS_TRACING, 'events', 'kvm')

+        fields = self.walkdir(path)[1]

+        extra = []

+        for field in fields:

+            if field in self.filters:

+                filter_name_, filter_dicts = self.filters[field]

+                for name in filter_dicts:

+                    extra.append(field + '(' + name + ')')

+        fields += extra

+        return fields

+

+    def update_fields(self, fields_filter):

+        """Refresh fields, applying fields_filter"""

+        self._fields = [field for field in self.get_available_fields()

+                        if self.is_field_wanted(fields_filter, field)]

+

+    @staticmethod

+    def get_online_cpus():

+        """Returns a list of cpu id integers."""

+        def parse_int_list(list_string):

+            """Returns an int list from a string of comma separated integers and

+            integer ranges."""

+            integers = []

+            members = list_string.split(',')

+

+            for member in members:

+                if '-' not in member:

+                    integers.append(int(member))

+                else:

+                    int_range = member.split('-')

+                    integers.extend(range(int(int_range[0]),

+                                          int(int_range[1]) + 1))

+

+            return integers

+

+        with open('/sys/devices/system/cpu/online') as cpu_list:

+            cpu_string = cpu_list.readline()

+            return parse_int_list(cpu_string)

+

+    def setup_traces(self):

+        """Creates all event and group objects needed to be able to retrieve

+        data."""

+        fields = self.get_available_fields()

+        if self._pid > 0:

+            # Fetch list of all threads of the monitored pid, as qemu

+            # starts a thread for each vcpu.

+            path = os.path.join('/proc', str(self._pid), 'task')

+            groupids = self.walkdir(path)[1]

+        else:

+            groupids = self.get_online_cpus()

+

+        # The constant is needed as a buffer for python libs, std

+        # streams and other files that the script opens.

+        newlim = len(groupids) * len(fields) + 50

+        try:

+            softlim_, hardlim = resource.getrlimit(resource.RLIMIT_NOFILE)

+

+            if hardlim < newlim:

+                # Now we need CAP_SYS_RESOURCE, to increase the hard limit.

+                resource.setrlimit(resource.RLIMIT_NOFILE, (newlim, newlim))

+            else:

+                # Raising the soft limit is sufficient.

+                resource.setrlimit(resource.RLIMIT_NOFILE, (newlim, hardlim))

+

+        except ValueError:

+            sys.exit("NOFILE rlimit could not be raised to {0}".format(newlim))

+

+        for groupid in groupids:

+            group = Group()