mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-01-17 10:26:09 +00:00
dm vdo: fix function doc comment formatting
Signed-off-by: Matthew Sakai <msakai@redhat.com> Signed-off-by: Mikulas Patocka <mpatocka@redhat.com>
This commit is contained in:
parent
7e976b2b9d
commit
19ac19e02f
@ -209,8 +209,6 @@ static int initialize_info(struct vdo_page_cache *cache)
|
||||
/**
|
||||
* allocate_cache_components() - Allocate components of the cache which require their own
|
||||
* allocation.
|
||||
* @maximum_age: The number of journal blocks before a dirtied page is considered old and must be
|
||||
* written out.
|
||||
*
|
||||
* The caller is responsible for all clean up on errors.
|
||||
*
|
||||
|
@ -327,8 +327,9 @@ static u32 __must_check pack_status(struct data_vio_compression_status status)
|
||||
|
||||
/**
|
||||
* set_data_vio_compression_status() - Set the compression status of a data_vio.
|
||||
* @state: The expected current status of the data_vio.
|
||||
* @new_state: The status to set.
|
||||
* @data_vio: The data_vio to change.
|
||||
* @status: The expected current status of the data_vio.
|
||||
* @new_status: The status to set.
|
||||
*
|
||||
* Return: true if the new status was set, false if the data_vio's compression status did not
|
||||
* match the expected state, and so was left unchanged.
|
||||
@ -836,7 +837,7 @@ static void destroy_data_vio(struct data_vio *data_vio)
|
||||
* @vdo: The vdo to which the pool will belong.
|
||||
* @pool_size: The number of data_vios in the pool.
|
||||
* @discard_limit: The maximum number of data_vios which may be used for discards.
|
||||
* @pool: A pointer to hold the newly allocated pool.
|
||||
* @pool_ptr: A pointer to hold the newly allocated pool.
|
||||
*/
|
||||
int make_data_vio_pool(struct vdo *vdo, data_vio_count_t pool_size,
|
||||
data_vio_count_t discard_limit, struct data_vio_pool **pool_ptr)
|
||||
|
@ -565,7 +565,7 @@ static void wait_on_hash_lock(struct hash_lock *lock, struct data_vio *data_vio)
|
||||
* @waiter: The data_vio's waiter link.
|
||||
* @context: Not used.
|
||||
*/
|
||||
static void abort_waiter(struct vdo_waiter *waiter, void *context __always_unused)
|
||||
static void abort_waiter(struct vdo_waiter *waiter, void __always_unused *context)
|
||||
{
|
||||
write_data_vio(vdo_waiter_as_data_vio(waiter));
|
||||
}
|
||||
@ -1727,7 +1727,7 @@ static void report_bogus_lock_state(struct hash_lock *lock, struct data_vio *dat
|
||||
/**
|
||||
* vdo_continue_hash_lock() - Continue the processing state after writing, compressing, or
|
||||
* deduplicating.
|
||||
* @data_vio: The data_vio to continue processing in its hash lock.
|
||||
* @completion: The data_vio completion to continue processing in its hash lock.
|
||||
*
|
||||
* Asynchronously continue processing a data_vio in its hash lock after it has finished writing,
|
||||
* compressing, or deduplicating, so it can share the result with any data_vios waiting in the hash
|
||||
@ -1825,7 +1825,7 @@ static inline int assert_hash_lock_preconditions(const struct data_vio *data_vio
|
||||
|
||||
/**
|
||||
* vdo_acquire_hash_lock() - Acquire or share a lock on a record name.
|
||||
* @data_vio: The data_vio acquiring a lock on its record name.
|
||||
* @completion: The data_vio completion acquiring a lock on its record name.
|
||||
*
|
||||
* Acquire or share a lock on the hash (record name) of the data in a data_vio, updating the
|
||||
* data_vio to reference the lock. This must only be called in the correct thread for the zone. In
|
||||
@ -2679,7 +2679,8 @@ static void get_index_statistics(struct hash_zones *zones,
|
||||
|
||||
/**
|
||||
* vdo_get_dedupe_statistics() - Tally the statistics from all the hash zones and the UDS index.
|
||||
* @hash_zones: The hash zones to query
|
||||
* @zones: The hash zones to query
|
||||
* @stats: A structure to store the statistics
|
||||
*
|
||||
* Return: The sum of the hash lock statistics from all hash zones plus the statistics from the UDS
|
||||
* index
|
||||
|
@ -858,7 +858,7 @@ static int __must_check make_partition(struct layout *layout, enum partition_id
|
||||
/**
|
||||
* vdo_initialize_layout() - Lay out the partitions of a vdo.
|
||||
* @size: The entire size of the vdo.
|
||||
* @origin: The start of the layout on the underlying storage in blocks.
|
||||
* @offset: The start of the layout on the underlying storage in blocks.
|
||||
* @block_map_blocks: The size of the block map partition.
|
||||
* @journal_blocks: The size of the journal partition.
|
||||
* @summary_blocks: The size of the slab summary partition.
|
||||
|
@ -367,7 +367,7 @@ void __submit_metadata_vio(struct vio *vio, physical_block_number_t physical,
|
||||
* completions.
|
||||
* @max_requests_active: Number of bios for merge tracking.
|
||||
* @vdo: The vdo which will use this submitter.
|
||||
* @io_submitter: pointer to the new data structure.
|
||||
* @io_submitter_ptr: pointer to the new data structure.
|
||||
*
|
||||
* Return: VDO_SUCCESS or an error.
|
||||
*/
|
||||
|
@ -250,7 +250,6 @@ static void abort_packing(struct data_vio *data_vio)
|
||||
/**
|
||||
* release_compressed_write_waiter() - Update a data_vio for which a successful compressed write
|
||||
* has completed and send it on its way.
|
||||
|
||||
* @data_vio: The data_vio to release.
|
||||
* @allocation: The allocation to which the compressed block was written.
|
||||
*/
|
||||
@ -383,7 +382,7 @@ static void initialize_compressed_block(struct compressed_block *block, u16 size
|
||||
* @compression: The agent's compression_state to pack in to.
|
||||
* @data_vio: The data_vio to pack.
|
||||
* @offset: The offset into the compressed block at which to pack the fragment.
|
||||
* @compressed_block: The compressed block which will be written out when batch is fully packed.
|
||||
* @block: The compressed block which will be written out when batch is fully packed.
|
||||
*
|
||||
* Return: The new amount of space used.
|
||||
*/
|
||||
|
@ -517,7 +517,7 @@ static int allocate_and_lock_block(struct allocation *allocation)
|
||||
* @waiter: The allocating_vio that was waiting to allocate.
|
||||
* @context: The context (unused).
|
||||
*/
|
||||
static void retry_allocation(struct vdo_waiter *waiter, void *context __always_unused)
|
||||
static void retry_allocation(struct vdo_waiter *waiter, void __always_unused *context)
|
||||
{
|
||||
struct data_vio *data_vio = vdo_waiter_as_data_vio(waiter);
|
||||
|
||||
|
@ -1365,7 +1365,7 @@ static void add_queued_recovery_entries(struct recovery_journal_block *block)
|
||||
*
|
||||
* Implements waiter_callback_fn.
|
||||
*/
|
||||
static void write_block(struct vdo_waiter *waiter, void *context __always_unused)
|
||||
static void write_block(struct vdo_waiter *waiter, void __always_unused *context)
|
||||
{
|
||||
struct recovery_journal_block *block =
|
||||
container_of(waiter, struct recovery_journal_block, write_waiter);
|
||||
|
@ -1287,7 +1287,7 @@ static struct reference_block * __must_check get_reference_block(struct vdo_slab
|
||||
* slab_block_number_from_pbn() - Determine the index within the slab of a particular physical
|
||||
* block number.
|
||||
* @slab: The slab.
|
||||
* @physical_block_number: The physical block number.
|
||||
* @pbn: The physical block number.
|
||||
* @slab_block_number_ptr: A pointer to the slab block number.
|
||||
*
|
||||
* Return: VDO_SUCCESS or an error code.
|
||||
@ -1459,7 +1459,6 @@ static int increment_for_data(struct vdo_slab *slab, struct reference_block *blo
|
||||
* @block_number: The block to update.
|
||||
* @old_status: The reference status of the data block before this decrement.
|
||||
* @updater: The reference updater doing this operation in case we need to look up the pbn lock.
|
||||
* @lock: The pbn_lock associated with the block being decremented (may be NULL).
|
||||
* @counter_ptr: A pointer to the count for the data block (in, out).
|
||||
* @adjust_block_count: Whether to update the allocator's free block count.
|
||||
*
|
||||
@ -3232,8 +3231,7 @@ int vdo_enqueue_clean_slab_waiter(struct block_allocator *allocator,
|
||||
/**
|
||||
* vdo_modify_reference_count() - Modify the reference count of a block by first making a slab
|
||||
* journal entry and then updating the reference counter.
|
||||
*
|
||||
* @data_vio: The data_vio for which to add the entry.
|
||||
* @completion: The data_vio completion for which to add the entry.
|
||||
* @updater: Which of the data_vio's reference updaters is being submitted.
|
||||
*/
|
||||
void vdo_modify_reference_count(struct vdo_completion *completion,
|
||||
@ -4750,8 +4748,7 @@ void vdo_use_new_slabs(struct slab_depot *depot, struct vdo_completion *parent)
|
||||
/**
|
||||
* stop_scrubbing() - Tell the scrubber to stop scrubbing after it finishes the slab it is
|
||||
* currently working on.
|
||||
* @scrubber: The scrubber to stop.
|
||||
* @parent: The completion to notify when scrubbing has stopped.
|
||||
* @allocator: The block allocator owning the scrubber to stop.
|
||||
*/
|
||||
static void stop_scrubbing(struct block_allocator *allocator)
|
||||
{
|
||||
|
@ -643,7 +643,7 @@ static void finish_vdo(struct vdo *vdo)
|
||||
|
||||
/**
|
||||
* free_listeners() - Free the list of read-only listeners associated with a thread.
|
||||
* @thread_data: The thread holding the list to free.
|
||||
* @thread: The thread holding the list to free.
|
||||
*/
|
||||
static void free_listeners(struct vdo_thread *thread)
|
||||
{
|
||||
@ -852,7 +852,7 @@ int vdo_synchronous_flush(struct vdo *vdo)
|
||||
/**
|
||||
* vdo_get_state() - Get the current state of the vdo.
|
||||
* @vdo: The vdo.
|
||||
|
||||
*
|
||||
* Context: This method may be called from any thread.
|
||||
*
|
||||
* Return: The current state of the vdo.
|
||||
|
Loading…
x
Reference in New Issue
Block a user