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>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <46151c97-9f2e-407d-a9b7-fec1034281fb@infradead.org>
Date: Wed, 22 Jan 2025 23:44:21 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: kernel test robot <lkp@...el.com>, "Rafael J. Wysocki" <rafael@...nel.org>
Cc: oe-kbuild-all@...ts.linux.dev, linux-kernel@...r.kernel.org,
 Andrew Morton <akpm@...ux-foundation.org>,
 Linux Memory Management List <linux-mm@...ck.org>
Subject: Re: drivers/base/power/runtime.c:362: warning: Excess function
 parameter 'dev' description in '__rpm_callback'

Hi robot,

On 1/22/25 10:59 PM, kernel test robot wrote:
> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
> head:   21266b8df5224c4f677acf9f353eecc9094731f0
> commit: 7be6a87c2473957090995b7eb541e31d57a2c801 sparc: allow PM configs for sparc32 COMPILE_TEST

^^^ Not relevant.

> date:   1 year, 11 months ago
> config: sparc-randconfig-r032-20230416 (https://download.01.org/0day-ci/archive/20250123/202501231452.84vwjQqo-lkp@intel.com/config)
> compiler: sparc-linux-gcc (GCC) 12.4.0
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20250123/202501231452.84vwjQqo-lkp@intel.com/reproduce)
> 
> If you fix the issue in a separate patch/commit (i.e. not just a new version of
> the same patch/commit), kindly add following tags
> | Reported-by: kernel test robot <lkp@...el.com>
> | Closes: https://lore.kernel.org/oe-kbuild-all/202501231452.84vwjQqo-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):
> 
>>> drivers/base/power/runtime.c:362: warning: Excess function parameter 'dev' description in '__rpm_callback'
> 
> 
> vim +362 drivers/base/power/runtime.c
> 
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  354  
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  355  /**
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  356   * __rpm_callback - Run a given runtime PM callback for a given device.
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  357   * @cb: Runtime PM callback to run.
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  358   * @dev: Device to run the callback for.
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  359   */
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  360  static int __rpm_callback(int (*cb)(struct device *), struct device *dev)
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  361  	__releases(&dev->power.lock) __acquires(&dev->power.lock)

The kernel-doc warning is a bug in scripts/kernel-doc.

I don't know of anyone who is working on that bug.

The only fix that I know of for now is to change the /** to plain /* to that the
comment is not considered as kernel-doc notation. That should be OK since this is
a static function, not exported.


> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27 @362  {
> 63d00be69348fd Ulf Hansson       2021-06-08  363  	int retval = 0, idx;
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  364  	bool use_links = dev->power.links_count > 0;
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  365  
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  366  	if (dev->power.irq_safe) {
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  367  		spin_unlock(&dev->power.lock);
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  368  	} else {
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  369  		spin_unlock_irq(&dev->power.lock);
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  370  
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  371  		/*
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  372  		 * Resume suppliers if necessary.
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  373  		 *
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  374  		 * The device's runtime PM status cannot change until this
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  375  		 * routine returns, so it is safe to read the status outside of
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  376  		 * the lock.
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  377  		 */
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  378  		if (use_links && dev->power.runtime_status == RPM_RESUMING) {
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  379  			idx = device_links_read_lock();
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  380  
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  381  			retval = rpm_get_suppliers(dev);
> 5244f5e2d80125 Rafael J. Wysocki 2021-03-19  382  			if (retval) {
> 5244f5e2d80125 Rafael J. Wysocki 2021-03-19  383  				rpm_put_suppliers(dev);
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  384  				goto fail;
> 5244f5e2d80125 Rafael J. Wysocki 2021-03-19  385  			}
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  386  
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  387  			device_links_read_unlock(idx);
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  388  		}
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  389  	}
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  390  
> 63d00be69348fd Ulf Hansson       2021-06-08  391  	if (cb)
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  392  		retval = cb(dev);
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  393  
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  394  	if (dev->power.irq_safe) {
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  395  		spin_lock(&dev->power.lock);
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  396  	} else {
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  397  		/*
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  398  		 * If the device is suspending and the callback has returned
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  399  		 * success, drop the usage counters of the suppliers that have
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  400  		 * been reference counted on its resume.
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  401  		 *
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  402  		 * Do that if resume fails too.
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  403  		 */
> dbfa44782787dc Rafael J. Wysocki 2022-12-05  404  		if (use_links &&
> dbfa44782787dc Rafael J. Wysocki 2022-12-05  405  		    ((dev->power.runtime_status == RPM_SUSPENDING && !retval) ||
> dbfa44782787dc Rafael J. Wysocki 2022-12-05  406  		    (dev->power.runtime_status == RPM_RESUMING && retval))) {
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  407  			idx = device_links_read_lock();
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  408  
> 5244f5e2d80125 Rafael J. Wysocki 2021-03-19  409  			__rpm_put_suppliers(dev, false);
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  410  
> 5244f5e2d80125 Rafael J. Wysocki 2021-03-19  411  fail:
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  412  			device_links_read_unlock(idx);
> 0cab893f409c53 Rafael J. Wysocki 2021-03-19  413  		}
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  414  
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  415  		spin_lock_irq(&dev->power.lock);
> 21d5c57b372616 Rafael J. Wysocki 2016-10-30  416  	}
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  417  
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  418  	return retval;
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  419  }
> ad3c36a534bc7b Rafael J. Wysocki 2011-09-27  420  
> 
> :::::: The code at line 362 was first introduced by commit
> :::::: ad3c36a534bc7b945d7bffdda1c62e13bf93489a PM / Runtime: Don't run callbacks under lock for power.irq_safe set
> 
> :::::: TO: Rafael J. Wysocki <rjw@...k.pl>
> :::::: CC: Rafael J. Wysocki <rjw@...k.pl>

So why is this email not sent to Rafael?
I added his email address.

Thanks so much!
-- 
~Randy


Powered by blists - more mailing lists

Powered by Openwall GNU/*/Linux Powered by OpenVZ