From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-23.3 required=3.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 492DAC2B9F4 for ; Mon, 14 Jun 2021 13:20:29 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 3167D61245 for ; Mon, 14 Jun 2021 13:20:29 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233835AbhFNNWa (ORCPT ); Mon, 14 Jun 2021 09:22:30 -0400 Received: from mail-lj1-f177.google.com ([209.85.208.177]:34371 "EHLO mail-lj1-f177.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233802AbhFNNWa (ORCPT ); Mon, 14 Jun 2021 09:22:30 -0400 Received: by mail-lj1-f177.google.com with SMTP id bn21so20160095ljb.1 for ; Mon, 14 Jun 2021 06:20:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=SlrMZ4dwNYn/ZEK4g9WD4YfB6VDpQni4QzxQiKRf/5Q=; b=gh7ZHmgp265oLvqqvEuLJMVmvQevoPFQYJEVz2YVfV5rF6AdX2tw6jbNEyS9oqKRSf DAx+vZXJhN/8jPsH/6U6X1SHanCm+jfDrIeBc1o8E8aQQQSxVmU2xY3GPqZE4mmxuReZ yoL53V/auJl3zr/qpV3vTIW1ZlJtBIo6klS3ENQmrCRyzcZ7DgtdViGDKol1+CCpGt5v +QzHDIswq8gySkr9V0UTt8mJQGebnGJoBv6QtLSL310Z1WgMp4TVwXluXh+BImTXkE9r a0esStXpOWg89hsIjzwLBFORuqbw9IbHNItbUfapkBY22xJK4iU0NZHsjoPgyf6WoLEG 4kXg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=SlrMZ4dwNYn/ZEK4g9WD4YfB6VDpQni4QzxQiKRf/5Q=; b=ew/rs5DG/pT0Vkj78llzBeEuVaQgAIxc7+wfbzJIHO/UyjH//o+g1KdU3JoYiLazHK PkO1v0TKWwTbj3f0ufHfmFVqraB3Dv1kOY8YnHlB7qT4yBDtMk9fBWthDCB74y+0gKLS gME1FEmfDoaQpJglL+MjpVwcZvQkSziCUtsHTg2PzTGP6smbKmHZFeHX9DiqAipmEOXG esHwuGViOv1JcjCkyZokT2LGTV8hld8EHOoPsNuGEvA14s9NuABM3UV/leFPBz8ouJ17 IRrUk75QlcSJospxSxJcai3FHYMfdUJL8dci+fKmR709MX8pGWcz7h4YXqtO3GCy/hTv 0ydg== X-Gm-Message-State: AOAM530ORwOOJhLNa2wl1k5xKUKaIhXSYBntssJc0S8Hgoq5L9iDAUik FHk5vvd0+KUj0Hrqt0E3opgaWwtHkwYCX7eaLzwRdQ== X-Google-Smtp-Source: ABdhPJxLFgBwZYSWOFz+YE4WYc05v7MCMMRXGHJiA9VktBcIbsNdxJoFsu9oGwcnR++LD4Yxu0mR/mu0bpUhJ9OAcdA= X-Received: by 2002:a05:651c:d7:: with SMTP id 23mr13784560ljr.207.1623676754764; Mon, 14 Jun 2021 06:19:14 -0700 (PDT) MIME-Version: 1.0 References: <20210603211426.790093-1-jingzhangos@google.com> <20210603211426.790093-4-jingzhangos@google.com> In-Reply-To: From: Jing Zhang Date: Mon, 14 Jun 2021 08:19:02 -0500 Message-ID: Subject: Re: [PATCH v7 3/4] KVM: stats: Add documentation for statistics data binary interface To: Fuad Tabba Cc: KVM , KVMARM , LinuxMIPS , KVMPPC , LinuxS390 , Linuxkselftest , Paolo Bonzini , Marc Zyngier , James Morse , Julien Thierry , Suzuki K Poulose , Will Deacon , Huacai Chen , Aleksandar Markovic , Thomas Bogendoerfer , Paul Mackerras , Christian Borntraeger , Janosch Frank , David Hildenbrand , Cornelia Huck , Claudio Imbrenda , Sean Christopherson , Vitaly Kuznetsov , Jim Mattson , Peter Shier , Oliver Upton , David Rientjes , Emanuele Giuseppe Esposito , David Matlack , Ricardo Koller , Krish Sadhukhan Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-s390@vger.kernel.org Hi Fuad, On Mon, Jun 14, 2021 at 2:57 AM Fuad Tabba wrote: > > Hi Jing, > > > On Thu, Jun 3, 2021 at 10:14 PM Jing Zhang wrote: > > > > Update KVM API documentation for binary statistics. > > > > Reviewed-by: David Matlack > > Reviewed-by: Ricardo Koller > > Signed-off-by: Jing Zhang > > --- > > Documentation/virt/kvm/api.rst | 180 +++++++++++++++++++++++++++++++++ > > 1 file changed, 180 insertions(+) > > > > diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst > > index 7fcb2fd38f42..550bfbdf611b 100644 > > --- a/Documentation/virt/kvm/api.rst > > +++ b/Documentation/virt/kvm/api.rst > > @@ -5034,6 +5034,178 @@ see KVM_XEN_VCPU_SET_ATTR above. > > The KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADJUST type may not be used > > with the KVM_XEN_VCPU_GET_ATTR ioctl. > > > > +4.130 KVM_GET_STATS_FD > > +--------------------- > > nit: missing one - (to match the subtitle length) > > > + > > +:Capability: KVM_CAP_STATS_BINARY_FD > > +:Architectures: all > > +:Type: vm ioctl, vcpu ioctl > > +:Parameters: none > > +:Returns: statistics file descriptor on success, < 0 on error > > + > > +Errors: > > + > > + ====== ====================================================== > > + ENOMEM if the fd could not be created due to lack of memory > > + EMFILE if the number of opened files exceeds the limit > > + ====== ====================================================== > > + > > +The file descriptor can be used to read VM/vCPU statistics data in binary > > +format. The file data is organized into three blocks as below: > > ++-------------+ > > +| Header | > > ++-------------+ > > +| Descriptors | > > ++-------------+ > > +| Stats Data | > > ++-------------+ > > + > > +The Header block is always at the start of the file. It is only needed to be > > +read one time for the lifetime of the file descriptor. > > +It is in the form of ``struct kvm_stats_header`` as below:: > > + > > + #define KVM_STATS_ID_MAXLEN 64 > > + > > + struct kvm_stats_header { > > + char id[KVM_STATS_ID_MAXLEN]; > > + __u32 name_size; > > + __u32 count; > > + __u32 desc_offset; > > + __u32 data_offset; > > + }; > > + > > +The ``id`` field is identification for the corresponding KVM statistics. For > > +VM statistics, it is in the form of "kvm-{kvm pid}", like "kvm-12345". For > > +VCPU statistics, it is in the form of "kvm-{kvm pid}/vcpu-{vcpu id}", like > > +"kvm-12345/vcpu-12". > > + > > +The ``name_size`` field is the size (byte) of the statistics name string > > +(including trailing '\0') appended to the end of every statistics descriptor. > > + > > +The ``count`` field is the number of statistics. > > + > > +The ``desc_offset`` field is the offset of the Descriptors block from the start > > +of the file indicated by the file descriptor. > > + > > +The ``data_offset`` field is the offset of the Stats Data block from the start > > +of the file indicated by the file descriptor. > > + > > +The Descriptors block is only needed to be read once for the lifetime of the > > +file descriptor. It is an array of ``struct kvm_stats_desc`` as shown in > > +below code block:: > > + > > + #define KVM_STATS_TYPE_SHIFT 0 > > + #define KVM_STATS_TYPE_MASK (0xF << KVM_STATS_TYPE_SHIFT) > > + #define KVM_STATS_TYPE_CUMULATIVE (0x0 << KVM_STATS_TYPE_SHIFT) > > + #define KVM_STATS_TYPE_INSTANT (0x1 << KVM_STATS_TYPE_SHIFT) > > + #define KVM_STATS_TYPE_MAX KVM_STATS_TYPE_INSTANT > > + > > + #define KVM_STATS_UNIT_SHIFT 4 > > + #define KVM_STATS_UNIT_MASK (0xF << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_NONE (0x0 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_BYTES (0x1 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_SECONDS (0x2 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_CYCLES (0x3 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_MAX KVM_STATS_UNIT_CYCLES > > + > > + #define KVM_STATS_BASE_SHIFT 8 > > + #define KVM_STATS_BASE_MASK (0xF << KVM_STATS_BASE_SHIFT) > > + #define KVM_STATS_BASE_POW10 (0x0 << KVM_STATS_BASE_SHIFT) > > + #define KVM_STATS_BASE_POW2 (0x1 << KVM_STATS_BASE_SHIFT) > > + #define KVM_STATS_BASE_MAX KVM_STATS_BASE_POW2 > > + > > + struct kvm_stats_desc { > > + __u32 flags; > > + __s16 exponent; > > + __u16 size; > > + __u32 unused1; > > + __u32 unused2; > > + char name[0]; > > + }; > > + > > +The ``flags`` field contains the type and unit of the statistics data described > > +by this descriptor. The following flags are supported: > > + > > +Bits 0-3 of ``flags`` encode the type: > > + * ``KVM_STATS_TYPE_CUMULATIVE`` > > + The statistics data is cumulative. The value of data can only be increased. > > + Most of the counters used in KVM are of this type. > > + The corresponding ``count`` filed for this type is always 1. > > filed -> field > > > + * ``KVM_STATS_TYPE_INSTANT`` > > + The statistics data is instantaneous. Its value can be increased or > > + decreased. This type is usually used as a measurement of some resources, > > + like the number of dirty pages, the number of large pages, etc. > > + The corresponding ``count`` field for this type is always 1. > > + > > +Bits 4-7 of ``flags`` encode the unit: > > + * ``KVM_STATS_UNIT_NONE`` > > + There is no unit for the value of statistics data. This usually means that > > + the value is a simple counter of an event. > > + * ``KVM_STATS_UNIT_BYTES`` > > + It indicates that the statistics data is used to measure memory size, in the > > + unit of Byte, KiByte, MiByte, GiByte, etc. The unit of the data is > > + determined by the ``exponent`` field in the descriptor. The > > + ``KVM_STATS_BASE_POW2`` flag is valid in this case. The unit of the data is > > + determined by ``pow(2, exponent)``. For example, if value is 10, > > + ``exponent`` is 20, which means the unit of statistics data is MiByte, we > > + can get the statistics data in the unit of Byte by > > + ``value * pow(2, exponent) = 10 * pow(2, 20) = 10 MiByte`` which is > > + 10 * 1024 * 1024 Bytes. > > + * ``KVM_STATS_UNIT_SECONDS`` > > + It indicates that the statistics data is used to measure time/latency, in > > + the unit of nanosecond, microsecond, millisecond and second. The unit of the > > + data is determined by the ``exponent`` field in the descriptor. The > > + ``KVM_STATS_BASE_POW10`` flag is valid in this case. The unit of the data > > + is determined by ``pow(10, exponent)``. For example, if value is 2000000, > > + ``exponent`` is -6, which means the unit of statistics data is microsecond, > > + we can get the statistics data in the unit of second by > > + ``value * pow(10, exponent) = 2000000 * pow(10, -6) = 2 seconds``. > > + * ``KVM_STATS_UNIT_CYCLES`` > > + It indicates that the statistics data is used to measure CPU clock cycles. > > + The ``KVM_STATS_BASE_POW10`` flag is valid in this case. For example, if > > + value is 200, ``exponent`` is 4, we can get the number of CPU clock cycles > > + by ``value * pow(10, exponent) = 200 * pow(10, 4) = 2000000``. > > + > > +Bits 7-11 of ``flags`` encode the base: > > Bits 8-11 > > > + * ``KVM_STATS_BASE_POW10`` > > + The scale is based on power of 10. It is used for measurement of time and > > + CPU clock cycles. > > + * ``KVM_STATS_BASE_POW2`` > > + The scale is based on power of 2. It is used for measurement of memory size. > > + > > +The ``exponent`` field is the scale of corresponding statistics data. For > > +example, if the unit is ``KVM_STATS_UNIT_BYTES``, the base is > > +``KVM_STATS_BASE_POW2``, the ``exponent`` is 10, then we know that the real > > +unit of the statistics data is KBytes a.k.a pow(2, 10) = 1024 bytes. > > + > > +The ``size`` field is the number of values of this statistics data. It is in the > > +unit of ``unsigned long`` for VM or ``__u64`` for VCPU. > > + > > +The ``unused1`` and ``unused2`` fields are reserved for future > > +support for other types of statistics data, like log/linear histogram. > > + > > +The ``name`` field points to the name string of the statistics data. The name > > +string starts at the end of ``struct kvm_stats_desc``. > > +The maximum length (including trailing '\0') is indicated by ``name_size`` > > +in ``struct kvm_stats_header``. > > + > > +The Stats Data block contains an array of data values of type ``struct > > +kvm_vm_stats_data`` or ``struct kvm_vcpu_stats_data``. It would be read by > > +user space periodically to pull statistics data. > > +The order of data value in Stats Data block is the same as the order of > > +descriptors in Descriptors block. > > + * Statistics data for VM:: > > + > > + struct kvm_vm_stats_data { > > + unsigned long value[0]; > > + }; > > + > > + * Statistics data for VCPU:: > > + > > + struct kvm_vcpu_stats_data { > > + __u64 value[0]; > > + }; > > + > > 5. The kvm_run structure > > ======================== > > > > @@ -6891,3 +7063,11 @@ This capability is always enabled. > > This capability indicates that the KVM virtual PTP service is > > supported in the host. A VMM can check whether the service is > > available to the guest on migration. > > + > > +8.33 KVM_CAP_STATS_BINARY_FD > > +---------------------------- > > + > > +:Architectures: all > > + > > +This capability indicates the feature that user space can create get a file > > +descriptor for every VM and VCPU to read statistics data in binary format. > > nit: user space -> userspace (it's spelled that way throughout this document) > > Cheers, > /fuad > > > -- > > 2.32.0.rc1.229.g3e70b5a671-goog > > > > _______________________________________________ > > kvmarm mailing list > > kvmarm@lists.cs.columbia.edu > > https://lists.cs.columbia.edu/mailman/listinfo/kvmarm Thanks for the review! Jing From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.5 required=3.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED,DKIM_INVALID,DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8EB30C2B9F4 for ; Mon, 14 Jun 2021 13:19:22 +0000 (UTC) Received: from mm01.cs.columbia.edu (mm01.cs.columbia.edu [128.59.11.253]) by mail.kernel.org (Postfix) with ESMTP id EFB4D6128C for ; Mon, 14 Jun 2021 13:19:21 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org EFB4D6128C Authentication-Results: mail.kernel.org; dmarc=fail (p=reject dis=none) header.from=google.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=kvmarm-bounces@lists.cs.columbia.edu Received: from localhost (localhost [127.0.0.1]) by mm01.cs.columbia.edu (Postfix) with ESMTP id 6F7EA4B08A; Mon, 14 Jun 2021 09:19:21 -0400 (EDT) X-Virus-Scanned: at lists.cs.columbia.edu Authentication-Results: mm01.cs.columbia.edu (amavisd-new); dkim=softfail (fail, message has been altered) header.i=@google.com Received: from mm01.cs.columbia.edu ([127.0.0.1]) by localhost (mm01.cs.columbia.edu [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id zW0YLeuxSlRf; Mon, 14 Jun 2021 09:19:19 -0400 (EDT) Received: from mm01.cs.columbia.edu (localhost [127.0.0.1]) by mm01.cs.columbia.edu (Postfix) with ESMTP id 997E54B086; Mon, 14 Jun 2021 09:19:19 -0400 (EDT) Received: from localhost (localhost [127.0.0.1]) by mm01.cs.columbia.edu (Postfix) with ESMTP id 271BE4B07F for ; Mon, 14 Jun 2021 09:19:18 -0400 (EDT) X-Virus-Scanned: at lists.cs.columbia.edu Received: from mm01.cs.columbia.edu ([127.0.0.1]) by localhost (mm01.cs.columbia.edu [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Q-XoOFSW3R0U for ; Mon, 14 Jun 2021 09:19:16 -0400 (EDT) Received: from mail-lj1-f172.google.com (mail-lj1-f172.google.com [209.85.208.172]) by mm01.cs.columbia.edu (Postfix) with ESMTPS id 671194A2E5 for ; Mon, 14 Jun 2021 09:19:16 -0400 (EDT) Received: by mail-lj1-f172.google.com with SMTP id 131so20179700ljj.3 for ; Mon, 14 Jun 2021 06:19:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=SlrMZ4dwNYn/ZEK4g9WD4YfB6VDpQni4QzxQiKRf/5Q=; b=gh7ZHmgp265oLvqqvEuLJMVmvQevoPFQYJEVz2YVfV5rF6AdX2tw6jbNEyS9oqKRSf DAx+vZXJhN/8jPsH/6U6X1SHanCm+jfDrIeBc1o8E8aQQQSxVmU2xY3GPqZE4mmxuReZ yoL53V/auJl3zr/qpV3vTIW1ZlJtBIo6klS3ENQmrCRyzcZ7DgtdViGDKol1+CCpGt5v +QzHDIswq8gySkr9V0UTt8mJQGebnGJoBv6QtLSL310Z1WgMp4TVwXluXh+BImTXkE9r a0esStXpOWg89hsIjzwLBFORuqbw9IbHNItbUfapkBY22xJK4iU0NZHsjoPgyf6WoLEG 4kXg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=SlrMZ4dwNYn/ZEK4g9WD4YfB6VDpQni4QzxQiKRf/5Q=; b=POdKGSiZTbUHGFaPaThazWkych0yPhZdoE+X870DTJ60YiU3c9hkW0iqxZQYhduwAN /e2g8xeNqUinT6yj9oVtqnCMJR4HpAaCFTmzx4TPgyfWdpFSt9NiwFjRXsR8L9IfSzde g23akIVo6Y4fAdxdkEDcwZJfdZIZEXehkLFuyw3jyRO69A6+NNLwtLESDL5G6Bw7qLsH 6fZmqKLmdMT0PkjlL1NWqNnh+PiG/VAPYUzjp9Qn8oRCn87PyYDjSR7TlvdMycvF/a16 HeYxoXYVXYVCDIGf3s1hbzH12c0nLogRtFO+Qg5Mo/N183ouNzlmAF9eHZAVz5pTLGEB MeEw== X-Gm-Message-State: AOAM532Paav+yGnp2DGu6f+Su2VSb+IsrRNJrDz0br+T2Di30C+S2OwC nTCKHi/KXXmzIYr7dwgGOE4m2ovuQPAyYKriAcml8g== X-Google-Smtp-Source: ABdhPJxLFgBwZYSWOFz+YE4WYc05v7MCMMRXGHJiA9VktBcIbsNdxJoFsu9oGwcnR++LD4Yxu0mR/mu0bpUhJ9OAcdA= X-Received: by 2002:a05:651c:d7:: with SMTP id 23mr13784560ljr.207.1623676754764; Mon, 14 Jun 2021 06:19:14 -0700 (PDT) MIME-Version: 1.0 References: <20210603211426.790093-1-jingzhangos@google.com> <20210603211426.790093-4-jingzhangos@google.com> In-Reply-To: From: Jing Zhang Date: Mon, 14 Jun 2021 08:19:02 -0500 Message-ID: Subject: Re: [PATCH v7 3/4] KVM: stats: Add documentation for statistics data binary interface To: Fuad Tabba Cc: KVM , David Hildenbrand , Paul Mackerras , Linuxkselftest , Claudio Imbrenda , Will Deacon , KVMARM , Emanuele Giuseppe Esposito , LinuxS390 , Janosch Frank , Marc Zyngier , Huacai Chen , Christian Borntraeger , Aleksandar Markovic , David Rientjes , KVMPPC , Krish Sadhukhan , David Matlack , Jim Mattson , Thomas Bogendoerfer , Sean Christopherson , Cornelia Huck , Peter Shier , LinuxMIPS , Paolo Bonzini , Vitaly Kuznetsov X-BeenThere: kvmarm@lists.cs.columbia.edu X-Mailman-Version: 2.1.14 Precedence: list List-Id: Where KVM/ARM decisions are made List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: kvmarm-bounces@lists.cs.columbia.edu Sender: kvmarm-bounces@lists.cs.columbia.edu Hi Fuad, On Mon, Jun 14, 2021 at 2:57 AM Fuad Tabba wrote: > > Hi Jing, > > > On Thu, Jun 3, 2021 at 10:14 PM Jing Zhang wrote: > > > > Update KVM API documentation for binary statistics. > > > > Reviewed-by: David Matlack > > Reviewed-by: Ricardo Koller > > Signed-off-by: Jing Zhang > > --- > > Documentation/virt/kvm/api.rst | 180 +++++++++++++++++++++++++++++++++ > > 1 file changed, 180 insertions(+) > > > > diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst > > index 7fcb2fd38f42..550bfbdf611b 100644 > > --- a/Documentation/virt/kvm/api.rst > > +++ b/Documentation/virt/kvm/api.rst > > @@ -5034,6 +5034,178 @@ see KVM_XEN_VCPU_SET_ATTR above. > > The KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADJUST type may not be used > > with the KVM_XEN_VCPU_GET_ATTR ioctl. > > > > +4.130 KVM_GET_STATS_FD > > +--------------------- > > nit: missing one - (to match the subtitle length) > > > + > > +:Capability: KVM_CAP_STATS_BINARY_FD > > +:Architectures: all > > +:Type: vm ioctl, vcpu ioctl > > +:Parameters: none > > +:Returns: statistics file descriptor on success, < 0 on error > > + > > +Errors: > > + > > + ====== ====================================================== > > + ENOMEM if the fd could not be created due to lack of memory > > + EMFILE if the number of opened files exceeds the limit > > + ====== ====================================================== > > + > > +The file descriptor can be used to read VM/vCPU statistics data in binary > > +format. The file data is organized into three blocks as below: > > ++-------------+ > > +| Header | > > ++-------------+ > > +| Descriptors | > > ++-------------+ > > +| Stats Data | > > ++-------------+ > > + > > +The Header block is always at the start of the file. It is only needed to be > > +read one time for the lifetime of the file descriptor. > > +It is in the form of ``struct kvm_stats_header`` as below:: > > + > > + #define KVM_STATS_ID_MAXLEN 64 > > + > > + struct kvm_stats_header { > > + char id[KVM_STATS_ID_MAXLEN]; > > + __u32 name_size; > > + __u32 count; > > + __u32 desc_offset; > > + __u32 data_offset; > > + }; > > + > > +The ``id`` field is identification for the corresponding KVM statistics. For > > +VM statistics, it is in the form of "kvm-{kvm pid}", like "kvm-12345". For > > +VCPU statistics, it is in the form of "kvm-{kvm pid}/vcpu-{vcpu id}", like > > +"kvm-12345/vcpu-12". > > + > > +The ``name_size`` field is the size (byte) of the statistics name string > > +(including trailing '\0') appended to the end of every statistics descriptor. > > + > > +The ``count`` field is the number of statistics. > > + > > +The ``desc_offset`` field is the offset of the Descriptors block from the start > > +of the file indicated by the file descriptor. > > + > > +The ``data_offset`` field is the offset of the Stats Data block from the start > > +of the file indicated by the file descriptor. > > + > > +The Descriptors block is only needed to be read once for the lifetime of the > > +file descriptor. It is an array of ``struct kvm_stats_desc`` as shown in > > +below code block:: > > + > > + #define KVM_STATS_TYPE_SHIFT 0 > > + #define KVM_STATS_TYPE_MASK (0xF << KVM_STATS_TYPE_SHIFT) > > + #define KVM_STATS_TYPE_CUMULATIVE (0x0 << KVM_STATS_TYPE_SHIFT) > > + #define KVM_STATS_TYPE_INSTANT (0x1 << KVM_STATS_TYPE_SHIFT) > > + #define KVM_STATS_TYPE_MAX KVM_STATS_TYPE_INSTANT > > + > > + #define KVM_STATS_UNIT_SHIFT 4 > > + #define KVM_STATS_UNIT_MASK (0xF << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_NONE (0x0 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_BYTES (0x1 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_SECONDS (0x2 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_CYCLES (0x3 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_MAX KVM_STATS_UNIT_CYCLES > > + > > + #define KVM_STATS_BASE_SHIFT 8 > > + #define KVM_STATS_BASE_MASK (0xF << KVM_STATS_BASE_SHIFT) > > + #define KVM_STATS_BASE_POW10 (0x0 << KVM_STATS_BASE_SHIFT) > > + #define KVM_STATS_BASE_POW2 (0x1 << KVM_STATS_BASE_SHIFT) > > + #define KVM_STATS_BASE_MAX KVM_STATS_BASE_POW2 > > + > > + struct kvm_stats_desc { > > + __u32 flags; > > + __s16 exponent; > > + __u16 size; > > + __u32 unused1; > > + __u32 unused2; > > + char name[0]; > > + }; > > + > > +The ``flags`` field contains the type and unit of the statistics data described > > +by this descriptor. The following flags are supported: > > + > > +Bits 0-3 of ``flags`` encode the type: > > + * ``KVM_STATS_TYPE_CUMULATIVE`` > > + The statistics data is cumulative. The value of data can only be increased. > > + Most of the counters used in KVM are of this type. > > + The corresponding ``count`` filed for this type is always 1. > > filed -> field > > > + * ``KVM_STATS_TYPE_INSTANT`` > > + The statistics data is instantaneous. Its value can be increased or > > + decreased. This type is usually used as a measurement of some resources, > > + like the number of dirty pages, the number of large pages, etc. > > + The corresponding ``count`` field for this type is always 1. > > + > > +Bits 4-7 of ``flags`` encode the unit: > > + * ``KVM_STATS_UNIT_NONE`` > > + There is no unit for the value of statistics data. This usually means that > > + the value is a simple counter of an event. > > + * ``KVM_STATS_UNIT_BYTES`` > > + It indicates that the statistics data is used to measure memory size, in the > > + unit of Byte, KiByte, MiByte, GiByte, etc. The unit of the data is > > + determined by the ``exponent`` field in the descriptor. The > > + ``KVM_STATS_BASE_POW2`` flag is valid in this case. The unit of the data is > > + determined by ``pow(2, exponent)``. For example, if value is 10, > > + ``exponent`` is 20, which means the unit of statistics data is MiByte, we > > + can get the statistics data in the unit of Byte by > > + ``value * pow(2, exponent) = 10 * pow(2, 20) = 10 MiByte`` which is > > + 10 * 1024 * 1024 Bytes. > > + * ``KVM_STATS_UNIT_SECONDS`` > > + It indicates that the statistics data is used to measure time/latency, in > > + the unit of nanosecond, microsecond, millisecond and second. The unit of the > > + data is determined by the ``exponent`` field in the descriptor. The > > + ``KVM_STATS_BASE_POW10`` flag is valid in this case. The unit of the data > > + is determined by ``pow(10, exponent)``. For example, if value is 2000000, > > + ``exponent`` is -6, which means the unit of statistics data is microsecond, > > + we can get the statistics data in the unit of second by > > + ``value * pow(10, exponent) = 2000000 * pow(10, -6) = 2 seconds``. > > + * ``KVM_STATS_UNIT_CYCLES`` > > + It indicates that the statistics data is used to measure CPU clock cycles. > > + The ``KVM_STATS_BASE_POW10`` flag is valid in this case. For example, if > > + value is 200, ``exponent`` is 4, we can get the number of CPU clock cycles > > + by ``value * pow(10, exponent) = 200 * pow(10, 4) = 2000000``. > > + > > +Bits 7-11 of ``flags`` encode the base: > > Bits 8-11 > > > + * ``KVM_STATS_BASE_POW10`` > > + The scale is based on power of 10. It is used for measurement of time and > > + CPU clock cycles. > > + * ``KVM_STATS_BASE_POW2`` > > + The scale is based on power of 2. It is used for measurement of memory size. > > + > > +The ``exponent`` field is the scale of corresponding statistics data. For > > +example, if the unit is ``KVM_STATS_UNIT_BYTES``, the base is > > +``KVM_STATS_BASE_POW2``, the ``exponent`` is 10, then we know that the real > > +unit of the statistics data is KBytes a.k.a pow(2, 10) = 1024 bytes. > > + > > +The ``size`` field is the number of values of this statistics data. It is in the > > +unit of ``unsigned long`` for VM or ``__u64`` for VCPU. > > + > > +The ``unused1`` and ``unused2`` fields are reserved for future > > +support for other types of statistics data, like log/linear histogram. > > + > > +The ``name`` field points to the name string of the statistics data. The name > > +string starts at the end of ``struct kvm_stats_desc``. > > +The maximum length (including trailing '\0') is indicated by ``name_size`` > > +in ``struct kvm_stats_header``. > > + > > +The Stats Data block contains an array of data values of type ``struct > > +kvm_vm_stats_data`` or ``struct kvm_vcpu_stats_data``. It would be read by > > +user space periodically to pull statistics data. > > +The order of data value in Stats Data block is the same as the order of > > +descriptors in Descriptors block. > > + * Statistics data for VM:: > > + > > + struct kvm_vm_stats_data { > > + unsigned long value[0]; > > + }; > > + > > + * Statistics data for VCPU:: > > + > > + struct kvm_vcpu_stats_data { > > + __u64 value[0]; > > + }; > > + > > 5. The kvm_run structure > > ======================== > > > > @@ -6891,3 +7063,11 @@ This capability is always enabled. > > This capability indicates that the KVM virtual PTP service is > > supported in the host. A VMM can check whether the service is > > available to the guest on migration. > > + > > +8.33 KVM_CAP_STATS_BINARY_FD > > +---------------------------- > > + > > +:Architectures: all > > + > > +This capability indicates the feature that user space can create get a file > > +descriptor for every VM and VCPU to read statistics data in binary format. > > nit: user space -> userspace (it's spelled that way throughout this document) > > Cheers, > /fuad > > > -- > > 2.32.0.rc1.229.g3e70b5a671-goog > > > > _______________________________________________ > > kvmarm mailing list > > kvmarm@lists.cs.columbia.edu > > https://lists.cs.columbia.edu/mailman/listinfo/kvmarm Thanks for the review! Jing _______________________________________________ kvmarm mailing list kvmarm@lists.cs.columbia.edu https://lists.cs.columbia.edu/mailman/listinfo/kvmarm From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jing Zhang Date: Mon, 14 Jun 2021 13:19:02 +0000 Subject: Re: [PATCH v7 3/4] KVM: stats: Add documentation for statistics data binary interface Message-Id: List-Id: References: <20210603211426.790093-1-jingzhangos@google.com> <20210603211426.790093-4-jingzhangos@google.com> In-Reply-To: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: Fuad Tabba Cc: KVM , KVMARM , LinuxMIPS , KVMPPC , LinuxS390 , Linuxkselftest , Paolo Bonzini , Marc Zyngier , James Morse , Julien Thierry , Suzuki K Poulose , Will Deacon , Huacai Chen , Aleksandar Markovic , Thomas Bogendoerfer , Paul Mackerras , Christian Borntraeger , Janosch Frank , David Hildenbrand , Cornelia Huck , Claudio Imbrenda , Sean Christopherson , Vitaly Kuznetsov , Jim Mattson , Peter Shier , Oliver Upton , David Rientjes , Emanuele Giuseppe Esposito , David Matlack , Ricardo Koller , Krish Sadhukhan Hi Fuad, On Mon, Jun 14, 2021 at 2:57 AM Fuad Tabba wrote: > > Hi Jing, > > > On Thu, Jun 3, 2021 at 10:14 PM Jing Zhang wrote: > > > > Update KVM API documentation for binary statistics. > > > > Reviewed-by: David Matlack > > Reviewed-by: Ricardo Koller > > Signed-off-by: Jing Zhang > > --- > > Documentation/virt/kvm/api.rst | 180 +++++++++++++++++++++++++++++++++ > > 1 file changed, 180 insertions(+) > > > > diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst > > index 7fcb2fd38f42..550bfbdf611b 100644 > > --- a/Documentation/virt/kvm/api.rst > > +++ b/Documentation/virt/kvm/api.rst > > @@ -5034,6 +5034,178 @@ see KVM_XEN_VCPU_SET_ATTR above. > > The KVM_XEN_VCPU_ATTR_TYPE_RUNSTATE_ADJUST type may not be used > > with the KVM_XEN_VCPU_GET_ATTR ioctl. > > > > +4.130 KVM_GET_STATS_FD > > +--------------------- > > nit: missing one - (to match the subtitle length) > > > + > > +:Capability: KVM_CAP_STATS_BINARY_FD > > +:Architectures: all > > +:Type: vm ioctl, vcpu ioctl > > +:Parameters: none > > +:Returns: statistics file descriptor on success, < 0 on error > > + > > +Errors: > > + > > + === =========================== > > + ENOMEM if the fd could not be created due to lack of memory > > + EMFILE if the number of opened files exceeds the limit > > + === =========================== > > + > > +The file descriptor can be used to read VM/vCPU statistics data in binary > > +format. The file data is organized into three blocks as below: > > ++-------------+ > > +| Header | > > ++-------------+ > > +| Descriptors | > > ++-------------+ > > +| Stats Data | > > ++-------------+ > > + > > +The Header block is always at the start of the file. It is only needed to be > > +read one time for the lifetime of the file descriptor. > > +It is in the form of ``struct kvm_stats_header`` as below:: > > + > > + #define KVM_STATS_ID_MAXLEN 64 > > + > > + struct kvm_stats_header { > > + char id[KVM_STATS_ID_MAXLEN]; > > + __u32 name_size; > > + __u32 count; > > + __u32 desc_offset; > > + __u32 data_offset; > > + }; > > + > > +The ``id`` field is identification for the corresponding KVM statistics. For > > +VM statistics, it is in the form of "kvm-{kvm pid}", like "kvm-12345". For > > +VCPU statistics, it is in the form of "kvm-{kvm pid}/vcpu-{vcpu id}", like > > +"kvm-12345/vcpu-12". > > + > > +The ``name_size`` field is the size (byte) of the statistics name string > > +(including trailing '\0') appended to the end of every statistics descriptor. > > + > > +The ``count`` field is the number of statistics. > > + > > +The ``desc_offset`` field is the offset of the Descriptors block from the start > > +of the file indicated by the file descriptor. > > + > > +The ``data_offset`` field is the offset of the Stats Data block from the start > > +of the file indicated by the file descriptor. > > + > > +The Descriptors block is only needed to be read once for the lifetime of the > > +file descriptor. It is an array of ``struct kvm_stats_desc`` as shown in > > +below code block:: > > + > > + #define KVM_STATS_TYPE_SHIFT 0 > > + #define KVM_STATS_TYPE_MASK (0xF << KVM_STATS_TYPE_SHIFT) > > + #define KVM_STATS_TYPE_CUMULATIVE (0x0 << KVM_STATS_TYPE_SHIFT) > > + #define KVM_STATS_TYPE_INSTANT (0x1 << KVM_STATS_TYPE_SHIFT) > > + #define KVM_STATS_TYPE_MAX KVM_STATS_TYPE_INSTANT > > + > > + #define KVM_STATS_UNIT_SHIFT 4 > > + #define KVM_STATS_UNIT_MASK (0xF << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_NONE (0x0 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_BYTES (0x1 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_SECONDS (0x2 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_CYCLES (0x3 << KVM_STATS_UNIT_SHIFT) > > + #define KVM_STATS_UNIT_MAX KVM_STATS_UNIT_CYCLES > > + > > + #define KVM_STATS_BASE_SHIFT 8 > > + #define KVM_STATS_BASE_MASK (0xF << KVM_STATS_BASE_SHIFT) > > + #define KVM_STATS_BASE_POW10 (0x0 << KVM_STATS_BASE_SHIFT) > > + #define KVM_STATS_BASE_POW2 (0x1 << KVM_STATS_BASE_SHIFT) > > + #define KVM_STATS_BASE_MAX KVM_STATS_BASE_POW2 > > + > > + struct kvm_stats_desc { > > + __u32 flags; > > + __s16 exponent; > > + __u16 size; > > + __u32 unused1; > > + __u32 unused2; > > + char name[0]; > > + }; > > + > > +The ``flags`` field contains the type and unit of the statistics data described > > +by this descriptor. The following flags are supported: > > + > > +Bits 0-3 of ``flags`` encode the type: > > + * ``KVM_STATS_TYPE_CUMULATIVE`` > > + The statistics data is cumulative. The value of data can only be increased. > > + Most of the counters used in KVM are of this type. > > + The corresponding ``count`` filed for this type is always 1. > > filed -> field > > > + * ``KVM_STATS_TYPE_INSTANT`` > > + The statistics data is instantaneous. Its value can be increased or > > + decreased. This type is usually used as a measurement of some resources, > > + like the number of dirty pages, the number of large pages, etc. > > + The corresponding ``count`` field for this type is always 1. > > + > > +Bits 4-7 of ``flags`` encode the unit: > > + * ``KVM_STATS_UNIT_NONE`` > > + There is no unit for the value of statistics data. This usually means that > > + the value is a simple counter of an event. > > + * ``KVM_STATS_UNIT_BYTES`` > > + It indicates that the statistics data is used to measure memory size, in the > > + unit of Byte, KiByte, MiByte, GiByte, etc. The unit of the data is > > + determined by the ``exponent`` field in the descriptor. The > > + ``KVM_STATS_BASE_POW2`` flag is valid in this case. The unit of the data is > > + determined by ``pow(2, exponent)``. For example, if value is 10, > > + ``exponent`` is 20, which means the unit of statistics data is MiByte, we > > + can get the statistics data in the unit of Byte by > > + ``value * pow(2, exponent) = 10 * pow(2, 20) = 10 MiByte`` which is > > + 10 * 1024 * 1024 Bytes. > > + * ``KVM_STATS_UNIT_SECONDS`` > > + It indicates that the statistics data is used to measure time/latency, in > > + the unit of nanosecond, microsecond, millisecond and second. The unit of the > > + data is determined by the ``exponent`` field in the descriptor. The > > + ``KVM_STATS_BASE_POW10`` flag is valid in this case. The unit of the data > > + is determined by ``pow(10, exponent)``. For example, if value is 2000000, > > + ``exponent`` is -6, which means the unit of statistics data is microsecond, > > + we can get the statistics data in the unit of second by > > + ``value * pow(10, exponent) = 2000000 * pow(10, -6) = 2 seconds``. > > + * ``KVM_STATS_UNIT_CYCLES`` > > + It indicates that the statistics data is used to measure CPU clock cycles. > > + The ``KVM_STATS_BASE_POW10`` flag is valid in this case. For example, if > > + value is 200, ``exponent`` is 4, we can get the number of CPU clock cycles > > + by ``value * pow(10, exponent) = 200 * pow(10, 4) = 2000000``. > > + > > +Bits 7-11 of ``flags`` encode the base: > > Bits 8-11 > > > + * ``KVM_STATS_BASE_POW10`` > > + The scale is based on power of 10. It is used for measurement of time and > > + CPU clock cycles. > > + * ``KVM_STATS_BASE_POW2`` > > + The scale is based on power of 2. It is used for measurement of memory size. > > + > > +The ``exponent`` field is the scale of corresponding statistics data. For > > +example, if the unit is ``KVM_STATS_UNIT_BYTES``, the base is > > +``KVM_STATS_BASE_POW2``, the ``exponent`` is 10, then we know that the real > > +unit of the statistics data is KBytes a.k.a pow(2, 10) = 1024 bytes. > > + > > +The ``size`` field is the number of values of this statistics data. It is in the > > +unit of ``unsigned long`` for VM or ``__u64`` for VCPU. > > + > > +The ``unused1`` and ``unused2`` fields are reserved for future > > +support for other types of statistics data, like log/linear histogram. > > + > > +The ``name`` field points to the name string of the statistics data. The name > > +string starts at the end of ``struct kvm_stats_desc``. > > +The maximum length (including trailing '\0') is indicated by ``name_size`` > > +in ``struct kvm_stats_header``. > > + > > +The Stats Data block contains an array of data values of type ``struct > > +kvm_vm_stats_data`` or ``struct kvm_vcpu_stats_data``. It would be read by > > +user space periodically to pull statistics data. > > +The order of data value in Stats Data block is the same as the order of > > +descriptors in Descriptors block. > > + * Statistics data for VM:: > > + > > + struct kvm_vm_stats_data { > > + unsigned long value[0]; > > + }; > > + > > + * Statistics data for VCPU:: > > + > > + struct kvm_vcpu_stats_data { > > + __u64 value[0]; > > + }; > > + > > 5. The kvm_run structure > > ============ > > > > @@ -6891,3 +7063,11 @@ This capability is always enabled. > > This capability indicates that the KVM virtual PTP service is > > supported in the host. A VMM can check whether the service is > > available to the guest on migration. > > + > > +8.33 KVM_CAP_STATS_BINARY_FD > > +---------------------------- > > + > > +:Architectures: all > > + > > +This capability indicates the feature that user space can create get a file > > +descriptor for every VM and VCPU to read statistics data in binary format. > > nit: user space -> userspace (it's spelled that way throughout this document) > > Cheers, > /fuad > > > -- > > 2.32.0.rc1.229.g3e70b5a671-goog > > > > _______________________________________________ > > kvmarm mailing list > > kvmarm@lists.cs.columbia.edu > > https://lists.cs.columbia.edu/mailman/listinfo/kvmarm Thanks for the review! Jing