Commit 571eff39 authored by Mike Snitzer's avatar Mike Snitzer

dm vdo: cleanup style for comments in structs

Use /* ... */ rather than /** ... */ if for no other reason than
syntax highlighting is improved (at least for me, in emacs: comments
are now red, code is yellow. Previously comments were also yellow).
Signed-off-by: default avatarMike Snitzer <snitzer@kernel.org>
Signed-off-by: default avatarSusan LeGendre-McGhee <slegendr@redhat.com>
Signed-off-by: default avatarMatthew Sakai <msakai@redhat.com>
parent d008f6ee
...@@ -216,17 +216,17 @@ enum block_map_page_type { ...@@ -216,17 +216,17 @@ enum block_map_page_type {
typedef struct list_head dirty_era_t[2]; typedef struct list_head dirty_era_t[2];
struct dirty_lists { struct dirty_lists {
/** The number of periods after which an element will be expired */ /* The number of periods after which an element will be expired */
block_count_t maximum_age; block_count_t maximum_age;
/** The oldest period which has unexpired elements */ /* The oldest period which has unexpired elements */
sequence_number_t oldest_period; sequence_number_t oldest_period;
/** One more than the current period */ /* One more than the current period */
sequence_number_t next_period; sequence_number_t next_period;
/** The offset in the array of lists of the oldest period */ /* The offset in the array of lists of the oldest period */
block_count_t offset; block_count_t offset;
/** Expired pages */ /* Expired pages */
dirty_era_t expired; dirty_era_t expired;
/** The lists of dirty pages */ /* The lists of dirty pages */
dirty_era_t eras[]; dirty_era_t eras[];
}; };
......
...@@ -17,10 +17,10 @@ enum { ...@@ -17,10 +17,10 @@ enum {
*/ */
VDO_BIO_ROTATION_INTERVAL_LIMIT = 1024, VDO_BIO_ROTATION_INTERVAL_LIMIT = 1024,
/** The number of entries on a block map page */ /* The number of entries on a block map page */
VDO_BLOCK_MAP_ENTRIES_PER_PAGE = 812, VDO_BLOCK_MAP_ENTRIES_PER_PAGE = 812,
/** The origin of the flat portion of the block map */ /* The origin of the flat portion of the block map */
VDO_BLOCK_MAP_FLAT_PAGE_ORIGIN = 1, VDO_BLOCK_MAP_FLAT_PAGE_ORIGIN = 1,
/* /*
...@@ -29,22 +29,22 @@ enum { ...@@ -29,22 +29,22 @@ enum {
*/ */
VDO_BLOCK_MAP_TREE_HEIGHT = 5, VDO_BLOCK_MAP_TREE_HEIGHT = 5,
/** The default number of bio submission queues. */ /* The default number of bio submission queues. */
DEFAULT_VDO_BIO_SUBMIT_QUEUE_COUNT = 4, DEFAULT_VDO_BIO_SUBMIT_QUEUE_COUNT = 4,
/** The number of contiguous PBNs to be submitted to a single bio queue. */ /* The number of contiguous PBNs to be submitted to a single bio queue. */
DEFAULT_VDO_BIO_SUBMIT_QUEUE_ROTATE_INTERVAL = 64, DEFAULT_VDO_BIO_SUBMIT_QUEUE_ROTATE_INTERVAL = 64,
/** The number of trees in the arboreal block map */ /* The number of trees in the arboreal block map */
DEFAULT_VDO_BLOCK_MAP_TREE_ROOT_COUNT = 60, DEFAULT_VDO_BLOCK_MAP_TREE_ROOT_COUNT = 60,
/** The default size of the recovery journal, in blocks */ /* The default size of the recovery journal, in blocks */
DEFAULT_VDO_RECOVERY_JOURNAL_SIZE = 32 * 1024, DEFAULT_VDO_RECOVERY_JOURNAL_SIZE = 32 * 1024,
/** The default size of each slab journal, in blocks */ /* The default size of each slab journal, in blocks */
DEFAULT_VDO_SLAB_JOURNAL_SIZE = 224, DEFAULT_VDO_SLAB_JOURNAL_SIZE = 224,
/** Unit test minimum */ /* Unit test minimum */
MINIMUM_VDO_SLAB_JOURNAL_BLOCKS = 2, MINIMUM_VDO_SLAB_JOURNAL_BLOCKS = 2,
/* /*
...@@ -54,16 +54,16 @@ enum { ...@@ -54,16 +54,16 @@ enum {
*/ */
VDO_LOCK_MAP_CAPACITY = 10000, VDO_LOCK_MAP_CAPACITY = 10000,
/** The maximum number of logical zones */ /* The maximum number of logical zones */
MAX_VDO_LOGICAL_ZONES = 60, MAX_VDO_LOGICAL_ZONES = 60,
/** The maximum number of physical zones */ /* The maximum number of physical zones */
MAX_VDO_PHYSICAL_ZONES = 16, MAX_VDO_PHYSICAL_ZONES = 16,
/** The base-2 logarithm of the maximum blocks in one slab */ /* The base-2 logarithm of the maximum blocks in one slab */
MAX_VDO_SLAB_BITS = 23, MAX_VDO_SLAB_BITS = 23,
/** The maximum number of slabs the slab depot supports */ /* The maximum number of slabs the slab depot supports */
MAX_VDO_SLABS = 8192, MAX_VDO_SLABS = 8192,
/* /*
...@@ -71,25 +71,25 @@ enum { ...@@ -71,25 +71,25 @@ enum {
*/ */
MAXIMUM_SIMULTANEOUS_VDO_BLOCK_MAP_RESTORATION_READS = 1024, MAXIMUM_SIMULTANEOUS_VDO_BLOCK_MAP_RESTORATION_READS = 1024,
/** The maximum number of entries in the slab summary */ /* The maximum number of entries in the slab summary */
MAXIMUM_VDO_SLAB_SUMMARY_ENTRIES = MAX_VDO_SLABS * MAX_VDO_PHYSICAL_ZONES, MAXIMUM_VDO_SLAB_SUMMARY_ENTRIES = MAX_VDO_SLABS * MAX_VDO_PHYSICAL_ZONES,
/** The maximum number of total threads in a VDO thread configuration. */ /* The maximum number of total threads in a VDO thread configuration. */
MAXIMUM_VDO_THREADS = 100, MAXIMUM_VDO_THREADS = 100,
/** The maximum number of VIOs in the system at once */ /* The maximum number of VIOs in the system at once */
MAXIMUM_VDO_USER_VIOS = 2048, MAXIMUM_VDO_USER_VIOS = 2048,
/** The only physical block size supported by VDO */ /* The only physical block size supported by VDO */
VDO_BLOCK_SIZE = 4096, VDO_BLOCK_SIZE = 4096,
/** The number of sectors per block */ /* The number of sectors per block */
VDO_SECTORS_PER_BLOCK = (VDO_BLOCK_SIZE >> SECTOR_SHIFT), VDO_SECTORS_PER_BLOCK = (VDO_BLOCK_SIZE >> SECTOR_SHIFT),
/** The size of a sector that will not be torn */ /* The size of a sector that will not be torn */
VDO_SECTOR_SIZE = 512, VDO_SECTOR_SIZE = 512,
/** The physical block number reserved for storing the zero block */ /* The physical block number reserved for storing the zero block */
VDO_ZERO_BLOCK = 0, VDO_ZERO_BLOCK = 0,
}; };
......
...@@ -155,7 +155,7 @@ struct block_map_page_header { ...@@ -155,7 +155,7 @@ struct block_map_page_header {
__le64 nonce; __le64 nonce;
__le64 pbn; __le64 pbn;
/** May be non-zero on disk */ /* May be non-zero on disk */
u8 unused_long_word[8]; u8 unused_long_word[8];
/* Whether this page has been written twice to disk */ /* Whether this page has been written twice to disk */
...@@ -197,11 +197,11 @@ extern const struct header VDO_BLOCK_MAP_HEADER_2_0; ...@@ -197,11 +197,11 @@ extern const struct header VDO_BLOCK_MAP_HEADER_2_0;
/* The state of the recovery journal as encoded in the VDO super block. */ /* The state of the recovery journal as encoded in the VDO super block. */
struct recovery_journal_state_7_0 { struct recovery_journal_state_7_0 {
/** Sequence number to start the journal */ /* Sequence number to start the journal */
sequence_number_t journal_start; sequence_number_t journal_start;
/** Number of logical blocks used by VDO */ /* Number of logical blocks used by VDO */
block_count_t logical_blocks_used; block_count_t logical_blocks_used;
/** Number of block map pages allocated */ /* Number of block map pages allocated */
block_count_t block_map_data_blocks; block_count_t block_map_data_blocks;
} __packed; } __packed;
......
...@@ -22,33 +22,33 @@ ...@@ -22,33 +22,33 @@
struct flusher { struct flusher {
struct vdo_completion completion; struct vdo_completion completion;
/** The vdo to which this flusher belongs */ /* The vdo to which this flusher belongs */
struct vdo *vdo; struct vdo *vdo;
/** The administrative state of the flusher */ /* The administrative state of the flusher */
struct admin_state state; struct admin_state state;
/** The current flush generation of the vdo */ /* The current flush generation of the vdo */
sequence_number_t flush_generation; sequence_number_t flush_generation;
/** The first unacknowledged flush generation */ /* The first unacknowledged flush generation */
sequence_number_t first_unacknowledged_generation; sequence_number_t first_unacknowledged_generation;
/** The queue of flush requests waiting to notify other threads */ /* The queue of flush requests waiting to notify other threads */
struct vdo_wait_queue notifiers; struct vdo_wait_queue notifiers;
/** The queue of flush requests waiting for VIOs to complete */ /* The queue of flush requests waiting for VIOs to complete */
struct vdo_wait_queue pending_flushes; struct vdo_wait_queue pending_flushes;
/** The flush generation for which notifications are being sent */ /* The flush generation for which notifications are being sent */
sequence_number_t notify_generation; sequence_number_t notify_generation;
/** The logical zone to notify next */ /* The logical zone to notify next */
struct logical_zone *logical_zone_to_notify; struct logical_zone *logical_zone_to_notify;
/** The ID of the thread on which flush requests should be made */ /* The ID of the thread on which flush requests should be made */
thread_id_t thread_id; thread_id_t thread_id;
/** The pool of flush requests */ /* The pool of flush requests */
mempool_t *flush_pool; mempool_t *flush_pool;
/** Bios waiting for a flush request to become available */ /* Bios waiting for a flush request to become available */
struct bio_list waiting_flush_bios; struct bio_list waiting_flush_bios;
/** The lock to protect the previous fields */ /* The lock to protect the previous fields */
spinlock_t lock; spinlock_t lock;
/** The rotor for selecting the bio queue for submitting flush bios */ /* The rotor for selecting the bio queue for submitting flush bios */
zone_count_t bio_queue_rotor; zone_count_t bio_queue_rotor;
/** The number of flushes submitted to the current bio queue */ /* The number of flushes submitted to the current bio queue */
int flush_count; int flush_count;
}; };
......
...@@ -89,27 +89,27 @@ enum vdo_zone_type { ...@@ -89,27 +89,27 @@ enum vdo_zone_type {
}; };
struct lock_counter { struct lock_counter {
/** The completion for notifying the owner of a lock release */ /* The completion for notifying the owner of a lock release */
struct vdo_completion completion; struct vdo_completion completion;
/** The number of logical zones which may hold locks */ /* The number of logical zones which may hold locks */
zone_count_t logical_zones; zone_count_t logical_zones;
/** The number of physical zones which may hold locks */ /* The number of physical zones which may hold locks */
zone_count_t physical_zones; zone_count_t physical_zones;
/** The number of locks */ /* The number of locks */
block_count_t locks; block_count_t locks;
/** Whether the lock release notification is in flight */ /* Whether the lock release notification is in flight */
atomic_t state; atomic_t state;
/** The number of logical zones which hold each lock */ /* The number of logical zones which hold each lock */
atomic_t *logical_zone_counts; atomic_t *logical_zone_counts;
/** The number of physical zones which hold each lock */ /* The number of physical zones which hold each lock */
atomic_t *physical_zone_counts; atomic_t *physical_zone_counts;
/** The per-lock counts for the journal zone */ /* The per-lock counts for the journal zone */
u16 *journal_counters; u16 *journal_counters;
/** The per-lock decrement counts for the journal zone */ /* The per-lock decrement counts for the journal zone */
atomic_t *journal_decrement_counts; atomic_t *journal_decrement_counts;
/** The per-zone, per-lock reference counts for logical zones */ /* The per-zone, per-lock reference counts for logical zones */
u16 *logical_counters; u16 *logical_counters;
/** The per-zone, per-lock reference counts for physical zones */ /* The per-zone, per-lock reference counts for physical zones */
u16 *physical_counters; u16 *physical_counters;
}; };
......
This diff is collapsed.
...@@ -25,13 +25,13 @@ ...@@ -25,13 +25,13 @@
#include "uds.h" #include "uds.h"
enum notifier_state { enum notifier_state {
/** Notifications are allowed but not in progress */ /* Notifications are allowed but not in progress */
MAY_NOTIFY, MAY_NOTIFY,
/** A notification is in progress */ /* A notification is in progress */
NOTIFYING, NOTIFYING,
/** Notifications are not allowed */ /* Notifications are not allowed */
MAY_NOT_NOTIFY, MAY_NOT_NOTIFY,
/** A notification has completed */ /* A notification has completed */
NOTIFIED, NOTIFIED,
}; };
......
...@@ -20,21 +20,21 @@ ...@@ -20,21 +20,21 @@
/* A vio_pool is a collection of preallocated vios. */ /* A vio_pool is a collection of preallocated vios. */
struct vio_pool { struct vio_pool {
/** The number of objects managed by the pool */ /* The number of objects managed by the pool */
size_t size; size_t size;
/** The list of objects which are available */ /* The list of objects which are available */
struct list_head available; struct list_head available;
/** The queue of requestors waiting for objects from the pool */ /* The queue of requestors waiting for objects from the pool */
struct vdo_wait_queue waiting; struct vdo_wait_queue waiting;
/** The number of objects currently in use */ /* The number of objects currently in use */
size_t busy_count; size_t busy_count;
/** The list of objects which are in use */ /* The list of objects which are in use */
struct list_head busy; struct list_head busy;
/** The ID of the thread on which this pool may be used */ /* The ID of the thread on which this pool may be used */
thread_id_t thread_id; thread_id_t thread_id;
/** The buffer backing the pool's vios */ /* The buffer backing the pool's vios */
char *buffer; char *buffer;
/** The pool entries */ /* The pool entries */
struct pooled_vio vios[]; struct pooled_vio vios[];
}; };
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment