kernel/power/swap.c:1518: warning: Function parameter or member 'snapshot_test' not described in 'swsusp_check'

From: kernel test robot
Date: Thu Aug 17 2023 - 03:01:54 EST


tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: 4853c74bd7ab7fdb83f319bd9ace8a08c031e9b6
commit: d6545e687271ab27472eebff770f2de6a5f1a464 PM: hibernate: remove the global snapshot_test variable
date: 2 months ago
config: powerpc-randconfig-r023-20230817 (https://download.01.org/0day-ci/archive/20230817/202308171425.aprr6uan-lkp@xxxxxxxxx/config)
compiler: powerpc-linux-gcc (GCC) 12.3.0
reproduce: (https://download.01.org/0day-ci/archive/20230817/202308171425.aprr6uan-lkp@xxxxxxxxx/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@xxxxxxxxx>
| Closes: https://lore.kernel.org/oe-kbuild-all/202308171425.aprr6uan-lkp@xxxxxxxxx/

All warnings (new ones prefixed by >>):

kernel/power/swap.c:543: warning: Function parameter or member 'handle' not described in 'save_image'
kernel/power/swap.c:543: warning: Function parameter or member 'snapshot' not described in 'save_image'
kernel/power/swap.c:543: warning: Function parameter or member 'nr_to_write' not described in 'save_image'
kernel/power/swap.c:890: warning: Function parameter or member 'nr_pages' not described in 'enough_swap'
kernel/power/swap.c:1061: warning: Function parameter or member 'handle' not described in 'load_image'
kernel/power/swap.c:1061: warning: Function parameter or member 'snapshot' not described in 'load_image'
kernel/power/swap.c:1061: warning: Function parameter or member 'nr_to_read' not described in 'load_image'
>> kernel/power/swap.c:1518: warning: Function parameter or member 'snapshot_test' not described in 'swsusp_check'
kernel/power/swap.c:1572: warning: Function parameter or member 'mode' not described in 'swsusp_close'

Kconfig warnings: (for reference only)
WARNING: unmet direct dependencies detected for HOTPLUG_CPU
Depends on [n]: SMP [=y] && (PPC_PSERIES [=n] || PPC_PMAC [=n] || PPC_POWERNV [=n] || FSL_SOC_BOOKE [=n])
Selected by [y]:
- PM_SLEEP_SMP [=y] && SMP [=y] && (ARCH_SUSPEND_POSSIBLE [=y] || ARCH_HIBERNATION_POSSIBLE [=y]) && PM_SLEEP [=y]


vim +1518 kernel/power/swap.c

61159a314bca64 Rafael J. Wysocki 2006-03-23 1512
61159a314bca64 Rafael J. Wysocki 2006-03-23 1513 /**
61159a314bca64 Rafael J. Wysocki 2006-03-23 1514 * swsusp_check - Check for swsusp signature in the resume device
61159a314bca64 Rafael J. Wysocki 2006-03-23 1515 */
61159a314bca64 Rafael J. Wysocki 2006-03-23 1516
d6545e687271ab Christoph Hellwig 2023-05-31 1517 int swsusp_check(bool snapshot_test)
61159a314bca64 Rafael J. Wysocki 2006-03-23 @1518 {
61159a314bca64 Rafael J. Wysocki 2006-03-23 1519 int error;
39fbef4b0f77f9 Ye Bin 2021-10-13 1520 void *holder;
5904de0d735bbb Chen Yu 2023-04-14 1521 fmode_t mode = FMODE_READ;
5904de0d735bbb Chen Yu 2023-04-14 1522
5904de0d735bbb Chen Yu 2023-04-14 1523 if (snapshot_test)
5904de0d735bbb Chen Yu 2023-04-14 1524 mode |= FMODE_EXCL;
61159a314bca64 Rafael J. Wysocki 2006-03-23 1525
d4d77629953eab Tejun Heo 2010-11-13 1526 hib_resume_bdev = blkdev_get_by_dev(swsusp_resume_device,
0718afd47f70cf Christoph Hellwig 2023-06-01 1527 mode, &holder, NULL);
8a0d613fa12e1b Jiri Slaby 2010-05-01 1528 if (!IS_ERR(hib_resume_bdev)) {
8a0d613fa12e1b Jiri Slaby 2010-05-01 1529 set_blocksize(hib_resume_bdev, PAGE_SIZE);
3ecb01df3261d3 Jan Beulich 2010-10-26 1530 clear_page(swsusp_header);
568e34ed7339e3 Bart Van Assche 2022-07-14 1531 error = hib_submit_io(REQ_OP_READ, swsusp_resume_block,
1b29c1643c0d82 Vivek Goyal 2007-05-02 1532 swsusp_header, NULL);
9a154d9d95b7b9 Rafael J. Wysocki 2006-12-06 1533 if (error)
76b57e613f6006 Jiri Slaby 2009-10-07 1534 goto put;
9a154d9d95b7b9 Rafael J. Wysocki 2006-12-06 1535
3624eb04c24861 Rafael J. Wysocki 2010-10-04 1536 if (!memcmp(HIBERNATE_SIG, swsusp_header->sig, 10)) {
1b29c1643c0d82 Vivek Goyal 2007-05-02 1537 memcpy(swsusp_header->sig, swsusp_header->orig_sig, 10);
61159a314bca64 Rafael J. Wysocki 2006-03-23 1538 /* Reset swap signature now */
568e34ed7339e3 Bart Van Assche 2022-07-14 1539 error = hib_submit_io(REQ_OP_WRITE | REQ_SYNC,
162b99e3119767 Mike Christie 2016-06-05 1540 swsusp_resume_block,
1b29c1643c0d82 Vivek Goyal 2007-05-02 1541 swsusp_header, NULL);
61159a314bca64 Rafael J. Wysocki 2006-03-23 1542 } else {
76b57e613f6006 Jiri Slaby 2009-10-07 1543 error = -EINVAL;
61159a314bca64 Rafael J. Wysocki 2006-03-23 1544 }
74d9555580c48a David Woodhouse 2021-11-08 1545 if (!error && swsusp_header->flags & SF_HW_SIG &&
74d9555580c48a David Woodhouse 2021-11-08 1546 swsusp_header->hw_sig != swsusp_hardware_signature) {
74d9555580c48a David Woodhouse 2021-11-08 1547 pr_info("Suspend image hardware signature mismatch (%08x now %08x); aborting resume.\n",
74d9555580c48a David Woodhouse 2021-11-08 1548 swsusp_header->hw_sig, swsusp_hardware_signature);
74d9555580c48a David Woodhouse 2021-11-08 1549 error = -EINVAL;
74d9555580c48a David Woodhouse 2021-11-08 1550 }
76b57e613f6006 Jiri Slaby 2009-10-07 1551
76b57e613f6006 Jiri Slaby 2009-10-07 1552 put:
61159a314bca64 Rafael J. Wysocki 2006-03-23 1553 if (error)
5904de0d735bbb Chen Yu 2023-04-14 1554 blkdev_put(hib_resume_bdev, mode);
61159a314bca64 Rafael J. Wysocki 2006-03-23 1555 else
64ec72a1ece37d Joe Perches 2017-09-27 1556 pr_debug("Image signature found, resuming\n");
61159a314bca64 Rafael J. Wysocki 2006-03-23 1557 } else {
8a0d613fa12e1b Jiri Slaby 2010-05-01 1558 error = PTR_ERR(hib_resume_bdev);
61159a314bca64 Rafael J. Wysocki 2006-03-23 1559 }
61159a314bca64 Rafael J. Wysocki 2006-03-23 1560
61159a314bca64 Rafael J. Wysocki 2006-03-23 1561 if (error)
64ec72a1ece37d Joe Perches 2017-09-27 1562 pr_debug("Image not found (code %d)\n", error);
61159a314bca64 Rafael J. Wysocki 2006-03-23 1563
61159a314bca64 Rafael J. Wysocki 2006-03-23 1564 return error;
61159a314bca64 Rafael J. Wysocki 2006-03-23 1565 }
61159a314bca64 Rafael J. Wysocki 2006-03-23 1566

:::::: The code at line 1518 was first introduced by commit
:::::: 61159a314bca6408320c3173c1282c64f5cdaa76 [PATCH] swsusp: separate swap-writing/reading code

:::::: TO: Rafael J. Wysocki <rjw@xxxxxxx>
:::::: CC: Linus Torvalds <torvalds@xxxxxxxxxxx>

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki