linux-kernel - arch/arm64/kvm/pmu-emul.c:453: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Date:   Sun, 6 Feb 2022 09:48:24 +0800
From:   kernel test robot <lkp@...el.com>
To:     Aditya Srivastava <yashsri421@...il.com>
Cc:     kbuild-all@...ts.01.org, linux-kernel@...r.kernel.org,
        Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Subject: arch/arm64/kvm/pmu-emul.c:453: warning: This comment starts with
 '/**', but isn't a kernel-doc comment. Refer
 Documentation/doc-guide/kernel-doc.rst

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   90c9e950c0def5c354b4a6154a2ddda3e5f214ac
commit: 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf scripts: kernel-doc: add warning for comment not following kernel-doc syntax
date:   10 months ago
config: arm64-buildonly-randconfig-r004-20220206 (https://download.01.org/0day-ci/archive/20220206/202202060606.bblLvJEU-lkp@intel.com/config)
compiler: aarch64-linux-gcc (GCC) 11.2.0
reproduce (this is a W=1 build):
        wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
        chmod +x ~/bin/make.cross
        # https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf
        git remote add linus https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
        git fetch --no-tags linus master
        git checkout 3e58e839150db0857dfcb3a0bb3d4af4c6ac1abf
        # save the config file to linux build tree
        mkdir build_dir
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-11.2.0 make.cross O=build_dir ARCH=arm64 SHELL=/bin/bash arch/arm64/kvm/

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp@...el.com>

All warnings (new ones prefixed by >>):

   arch/arm64/kvm/pmu-emul.c:219: warning: Function parameter or member 'vcpu' not described in 'kvm_pmu_stop_counter'
>> arch/arm64/kvm/pmu-emul.c:453: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * When perf interrupt is an NMI, we cannot safely notify the vcpu corresponding
   arch/arm64/kvm/pmu-emul.c:469: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * When the perf event overflows, set the overflow status and inform the vcpu.


vim +453 arch/arm64/kvm/pmu-emul.c

b02386eb7dac75 virt/kvm/arm/pmu.c        Shannon Zhao   2016-02-26  451  
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  452  /**
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24 @453   * When perf interrupt is an NMI, we cannot safely notify the vcpu corresponding
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  454   * to the event.
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  455   * This is why we need a callback to do it once outside of the NMI context.
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  456   */
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  457  static void kvm_pmu_perf_overflow_notify_vcpu(struct irq_work *work)
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  458  {
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  459  	struct kvm_vcpu *vcpu;
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  460  	struct kvm_pmu *pmu;
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  461  
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  462  	pmu = container_of(work, struct kvm_pmu, overflow_work);
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  463  	vcpu = kvm_pmc_to_vcpu(pmu->pmc);
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  464  
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  465  	kvm_vcpu_kick(vcpu);
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  466  }
95e92e45a454a1 arch/arm64/kvm/pmu-emul.c Julien Thierry 2020-09-24  467  

:::::: The code at line 453 was first introduced by commit
:::::: 95e92e45a454a10a8114294d0f7aec930fb85891 KVM: arm64: pmu: Make overflow handler NMI safe

:::::: TO: Julien Thierry <julien.thierry@....com>
:::::: CC: Will Deacon <will@...nel.org>

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org