drivers/md/dm-vdo/recovery-journal.c:1369: warning: Function parameter or struct member 'context' not described in 'write_block'

From: kernel test robot
Date: Wed Jan 15 2025 - 17:45:42 EST


tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: 619f0b6fad524f08d493a98d55bac9ab8895e3a6
commit: 19ac19e02ffa318e77f6b086b8fb3917da0aa893 dm vdo: fix function doc comment formatting
date: 8 weeks ago
config: x86_64-randconfig-161-20241019 (https://download.01.org/0day-ci/archive/20250116/202501160601.cTy8Bg4C-lkp@xxxxxxxxx/config)
compiler: gcc-12 (Debian 12.2.0-14) 12.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20250116/202501160601.cTy8Bg4C-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/202501160601.cTy8Bg4C-lkp@xxxxxxxxx/

All warnings (new ones prefixed by >>):

drivers/md/dm-vdo/recovery-journal.c:268: warning: Function parameter or struct member 'waiter' not described in 'continue_waiter'
drivers/md/dm-vdo/recovery-journal.c:268: warning: Function parameter or struct member 'context' not described in 'continue_waiter'
drivers/md/dm-vdo/recovery-journal.c:1085: warning: Function parameter or struct member 'waiter' not described in 'assign_entry'
drivers/md/dm-vdo/recovery-journal.c:1085: warning: Function parameter or struct member 'context' not described in 'assign_entry'
drivers/md/dm-vdo/recovery-journal.c:1172: warning: Function parameter or struct member 'waiter' not described in 'continue_committed_waiter'
drivers/md/dm-vdo/recovery-journal.c:1172: warning: Function parameter or struct member 'context' not described in 'continue_committed_waiter'
drivers/md/dm-vdo/recovery-journal.c:1369: warning: Function parameter or struct member 'waiter' not described in 'write_block'
>> drivers/md/dm-vdo/recovery-journal.c:1369: warning: Function parameter or struct member 'context' not described in 'write_block'
drivers/md/dm-vdo/recovery-journal.c:1620: warning: Function parameter or struct member 'state' not described in 'initiate_drain'


vim +1369 drivers/md/dm-vdo/recovery-journal.c

95a72357688803 Matthew Sakai 2023-11-16 1362
95a72357688803 Matthew Sakai 2023-11-16 1363 /**
95a72357688803 Matthew Sakai 2023-11-16 1364 * write_block() - Issue a block for writing.
95a72357688803 Matthew Sakai 2023-11-16 1365 *
95a72357688803 Matthew Sakai 2023-11-16 1366 * Implements waiter_callback_fn.
95a72357688803 Matthew Sakai 2023-11-16 1367 */
19ac19e02ffa31 Matthew Sakai 2024-10-02 1368 static void write_block(struct vdo_waiter *waiter, void __always_unused *context)
95a72357688803 Matthew Sakai 2023-11-16 @1369 {
95a72357688803 Matthew Sakai 2023-11-16 1370 struct recovery_journal_block *block =
95a72357688803 Matthew Sakai 2023-11-16 1371 container_of(waiter, struct recovery_journal_block, write_waiter);
95a72357688803 Matthew Sakai 2023-11-16 1372 struct recovery_journal *journal = block->journal;
95a72357688803 Matthew Sakai 2023-11-16 1373 struct packed_journal_header *header = get_block_header(block);
95a72357688803 Matthew Sakai 2023-11-16 1374
d6e260cc426164 Mike Snitzer 2023-11-20 1375 if (block->committing || !vdo_waitq_has_waiters(&block->entry_waiters) ||
d6e260cc426164 Mike Snitzer 2023-11-20 1376 is_read_only(journal))
95a72357688803 Matthew Sakai 2023-11-16 1377 return;
95a72357688803 Matthew Sakai 2023-11-16 1378
d6e260cc426164 Mike Snitzer 2023-11-20 1379 block->entries_in_commit = vdo_waitq_num_waiters(&block->entry_waiters);
95a72357688803 Matthew Sakai 2023-11-16 1380 add_queued_recovery_entries(block);
95a72357688803 Matthew Sakai 2023-11-16 1381
95a72357688803 Matthew Sakai 2023-11-16 1382 journal->pending_write_count += 1;
95a72357688803 Matthew Sakai 2023-11-16 1383 journal->events.blocks.written += 1;
95a72357688803 Matthew Sakai 2023-11-16 1384 journal->events.entries.written += block->entries_in_commit;
95a72357688803 Matthew Sakai 2023-11-16 1385
95a72357688803 Matthew Sakai 2023-11-16 1386 header->block_map_head = __cpu_to_le64(journal->block_map_head);
95a72357688803 Matthew Sakai 2023-11-16 1387 header->slab_journal_head = __cpu_to_le64(journal->slab_journal_head);
95a72357688803 Matthew Sakai 2023-11-16 1388 header->entry_count = __cpu_to_le16(block->entry_count);
95a72357688803 Matthew Sakai 2023-11-16 1389
95a72357688803 Matthew Sakai 2023-11-16 1390 block->committing = true;
95a72357688803 Matthew Sakai 2023-11-16 1391
95a72357688803 Matthew Sakai 2023-11-16 1392 /*
95a72357688803 Matthew Sakai 2023-11-16 1393 * We must issue a flush and a FUA for every commit. The flush is necessary to ensure that
95a72357688803 Matthew Sakai 2023-11-16 1394 * the data being referenced is stable. The FUA is necessary to ensure that the journal
95a72357688803 Matthew Sakai 2023-11-16 1395 * block itself is stable before allowing overwrites of the lbn's previous data.
95a72357688803 Matthew Sakai 2023-11-16 1396 */
f7f46761ccd9b4 Mike Snitzer 2023-08-25 1397 vdo_submit_metadata_vio(&block->vio, journal->origin + block->block_number,
b863d7f7503c42 Mike Snitzer 2024-02-05 1398 complete_write_endio, handle_write_error,
b863d7f7503c42 Mike Snitzer 2024-02-05 1399 REQ_OP_WRITE | REQ_PRIO | REQ_PREFLUSH | REQ_SYNC | REQ_FUA);
95a72357688803 Matthew Sakai 2023-11-16 1400 }
95a72357688803 Matthew Sakai 2023-11-16 1401

:::::: The code at line 1369 was first introduced by commit
:::::: 95a72357688803736bf60db973cbf94c0ff3a6da dm vdo: add the recovery journal

:::::: TO: Matthew Sakai <msakai@xxxxxxxxxx>
:::::: CC: Mike Snitzer <snitzer@xxxxxxxxxx>

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