From patchwork Tue May 24 08:50:07 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paolo Bonzini X-Patchwork-Id: 9133007 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 76DFD6075E for ; Tue, 24 May 2016 08:50:26 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 6587E2823B for ; Tue, 24 May 2016 08:50:26 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 57CD228294; Tue, 24 May 2016 08:50:26 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI,T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id BC0D62823B for ; Tue, 24 May 2016 08:50:25 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754669AbcEXIuU (ORCPT ); Tue, 24 May 2016 04:50:20 -0400 Received: from mail-wm0-f67.google.com ([74.125.82.67]:35849 "EHLO mail-wm0-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753364AbcEXIuQ (ORCPT ); Tue, 24 May 2016 04:50:16 -0400 Received: by mail-wm0-f67.google.com with SMTP id q62so3929391wmg.3 for ; Tue, 24 May 2016 01:50:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:subject:to:references:cc:from:message-id:date:user-agent :mime-version:in-reply-to:content-transfer-encoding; bh=Bo8BhgF8FyY/3X2O1Q3aguN9sNMcedFWCk6Sru3P2dM=; b=kZyxLeZhRDjPE+0ujXR8nW6D0vRqq3hLi7eq2WckB1GdJkGpeANMHqrIvbdau96gA3 NtEkKWpFCsiwfzKZ+6vpQNTwNA4wrfHgRI6/A3XUhZM+pqERjL3yhA715jwq6tpdnzyQ 4PpuCoiX/g3nu0AlFR2dw5AMsGU07fpLshjSSelmspqrAy388B13Rh2gUfs0fluFmJc9 GGnMCZ7McARKypj3eqMgoJVdEjY9tzDWuw1z72/L/AocAuGIPvmFkxk0iy4JoB9eWaeB dvqzIAolkhVTcW7IkoH5ZyfAQe8POPx6k6kh2I8MsAC5ejoEutZZhOwkwgmPAReQ7DEN NwtA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:sender:subject:to:references:cc:from:message-id :date:user-agent:mime-version:in-reply-to:content-transfer-encoding; bh=Bo8BhgF8FyY/3X2O1Q3aguN9sNMcedFWCk6Sru3P2dM=; b=G/g4CXbXcagIgo1ZbO9meq/EC/GJWM70Efj5/oSwYJauTgE6mWSh0cYxvP67jpKrXt ZoWJ1pQHNy045PeqMGKYzPX/cKwVQa5kY4ETEkztkUFp2mDFNwI9LZtvHsSKOGKKACJN 8zzMSNZVA5P2tM1XqmenIpgFmnN2kkAIERFN0fURRaE5PdkoR1N2THLL3h6YXe5tcfkJ Lh6XkHx4Ql7CFFudwWZuhCRsQqIxDBCeYMP0EjgcvOptWF0NNP97whviQSOfx1XWLisa uiiE4RS1lq32HrT2p6GK+l3rK+c1nc7NzK9G9bV+ZrejYX0cVv5bvmnIIAEINTu0XVYf ZD/w== X-Gm-Message-State: ALyK8tLrcQTkX6uZsImzKjLt4ObElZyD10yUmBpfFTgJleRxSygAyHXY5RWarFK2M8H/2w== X-Received: by 10.194.242.230 with SMTP id wt6mr3230612wjc.143.1464079814513; Tue, 24 May 2016 01:50:14 -0700 (PDT) Received: from [192.168.10.150] (dynamic-adsl-78-12-252-58.clienti.tiscali.it. [78.12.252.58]) by smtp.googlemail.com with ESMTPSA id o129sm17913645wmb.17.2016.05.24.01.50.11 (version=TLSv1/SSLv3 cipher=OTHER); Tue, 24 May 2016 01:50:12 -0700 (PDT) Subject: Re: [PATCH v2 0/5] Improve KVM per VM monitoring To: Janosch Frank , kvm@vger.kernel.org References: <1463570785-6766-1-git-send-email-frankja@linux.vnet.ibm.com> <74970e5d-1266-206d-c1df-8c2ed08266c5@redhat.com> <57440E25.7050401@linux.vnet.ibm.com> Cc: dan.carpenter@oracle.com From: Paolo Bonzini Message-ID: Date: Tue, 24 May 2016 10:50:07 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.0 MIME-Version: 1.0 In-Reply-To: <57440E25.7050401@linux.vnet.ibm.com> Sender: kvm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: kvm@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP On 24/05/2016 10:17, Janosch Frank wrote: > The script already outputs a help text, which could be extended to the > man's text. I.e. I left it out on purpose. > > Anyway, creating the manpage from asciidoc sources is a matter of having > the right packages and simply calling: > a2x --doctype manpage --format manpage file.txt > > Works flawlessly with your example and is much more readable than the > texi source. I would give it a try and add it to the first patch if you > do not have any concerns? I will include the following as a separate patch: ---------------- 8< --------------- From ccceb628a51e52a4b6384e6ef1cc9d88daf00a62 Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Tue, 24 May 2016 10:41:15 +0200 Subject: [PATCH] tools: Add kvm_stat man page Converted from the Texinfo source in QEMU to asciidoc. The a2x incantation was provided by Frank Janosch. Signed-off-by: Paolo Bonzini --- tools/kvm/kvm_stat/Makefile | 40 ++++++++++++++++++++++++-- tools/kvm/kvm_stat/kvm_stat.txt | 62 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 100 insertions(+), 2 deletions(-) create mode 100644 tools/kvm/kvm_stat/kvm_stat.txt diff --git a/tools/kvm/kvm_stat/Makefile b/tools/kvm/kvm_stat/Makefile index c639b8d30688..5b1cba57e3b3 100644 --- a/tools/kvm/kvm_stat/Makefile +++ b/tools/kvm/kvm_stat/Makefile @@ -1,5 +1,41 @@ +include ../../scripts/Makefile.include +include ../../scripts/utilities.mak BINDIR=usr/bin +MANDIR=usr/share/man +MAN1DIR=$(MANDIR)/man1 -install: - mkdir -p $(INSTALL_ROOT)/$(BINDIR) +MAN1=kvm_stat.1 + +A2X=a2x +a2x_path := $(call get-executable,$(A2X)) + +all: man + +ifneq ($(findstring $(MAKEFLAGS),s),s) + ifneq ($(V),1) + QUIET_A2X = @echo ' A2X '$@; + endif +endif + +%.1: %.txt +ifeq ($(a2x_path),) + $(error "You need to install asciidoc for man pages") +else + $(QUIET_A2X)$(A2X) --doctype manpage --format manpage $< +endif + +clean: + rm -f $(MAN1) + +man: $(MAN1) + +install-man: man + install -d -m 755 $(INSTALL_ROOT)/$(MAN1DIR) + install -m 644 kvm_stat.1 $(INSTALL_ROOT)/$(MAN1DIR) + +install-tools: + install -d -m 755 $(INSTALL_ROOT)/$(BINDIR) install -m 755 -p "kvm_stat" "$(INSTALL_ROOT)/$(BINDIR)/$(TARGET)" + +install: install-tools install-man +.PHONY: all clean man install-tools install-man install diff --git a/tools/kvm/kvm_stat/kvm_stat.txt b/tools/kvm/kvm_stat/kvm_stat.txt new file mode 100644 index 000000000000..039dee80ddcb --- /dev/null +++ b/tools/kvm/kvm_stat/kvm_stat.txt @@ -0,0 +1,62 @@ +kvm_stat(1) +=========== + +NAME +---- +kvm_stat - Report KVM kernel module event counters + +SYNOPSIS +-------- +[verse] +'kvm_stat' [OPTION]... + +DESCRIPTION +----------- +kvm_stat prints counts of KVM kernel module trace events. These events signify +state transitions such as guest mode entry and exit. + +This tool is useful for observing guest behavior from the host perspective. +Often conclusions about performance or buggy behavior can be drawn from the +output. + +The set of KVM kernel module trace events may be specific to the kernel version +or architecture. It is best to check the KVM kernel module source code for the +meaning of events. + +Note that trace events are counted globally across all running guests. + +OPTIONS +------- +-1:: +--once:: +--batch:: + run in batch mode for one second + +-l:: +--log:: + run in logging mode (like vmstat) + +-t:: +--tracepoints:: + retrieve statistics from tracepoints + +-d:: +--debugfs:: + retrieve statistics from debugfs + +-f:: +--fields=:: + fields to display (regex) + +-h:: +--help:: + + show help message + +SEE ALSO +-------- +'perf'(1), 'trace-cmd'(1) + +AUTHOR +------ +Stefan Hajnoczi