From a9d83cff1cecb493948525d9a27d2f885ab30e89 Mon Sep 17 00:00:00 2001 From: Bart Van Assche Date: Thu, 13 Jul 2023 09:54:22 -0700 Subject: [PATCH] diskutil: Improve disk utilization data structure documentation Document the meaning of the members of struct disk_util_stats. Signed-off-by: Bart Van Assche --- diskutil.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/diskutil.h b/diskutil.h index 7d7ef802..9dca42c4 100644 --- a/diskutil.h +++ b/diskutil.h @@ -7,6 +7,16 @@ #include "helper_thread.h" #include "fio_sem.h" +/** + * @ios: Number of I/O operations that have been completed successfully. + * @merges: Number of I/O operations that have been merged. + * @sectors: I/O size in 512-byte units. + * @ticks: Time spent on I/O in milliseconds. + * @io_ticks: CPU time spent on I/O in milliseconds. + * @time_in_queue: Weighted time spent doing I/O in milliseconds. + * + * For the array members, index 0 refers to reads and index 1 refers to writes. + */ struct disk_util_stats { uint64_t ios[2]; uint64_t merges[2]; @@ -18,7 +28,7 @@ struct disk_util_stats { }; /* - * Disk utils as read in /sys/block//stat + * Disk utilization as read from /sys/block//stat */ struct disk_util_stat { uint8_t name[FIO_DU_NAME_SZ]; -- 2.25.1