29 [[ ${EUID} -eq 0 ]] || fatal "You should be root to run this tool"
33 # Ensure the binaries are present and executable
35 if [ ! -x ${bin} ]; then
36 which ${bin} >/dev/null
37 [ $? -eq 0 ] || fatal "${bin} doesn't exists or is not executable"
44 if [ "${#drives[@]}" -eq 1 ]; then
45 device_name=$(block_dev_name ${drives[0]})
46 device_dir="/sys/block/${device_name}/device/"
47 pci_addr=$(cat ${device_dir}/address)
48 pci_dir="/sys/bus/pci/devices/${pci_addr}/"
49 cpu_to_search=$(cat ${pci_dir}/local_cpulist | cut -d"," -f 1 | cut -d"-" -f 1)
51 hint 'Passed multiple devices. Running on the first core.'
53 core_to_run=$(lscpu --all -pSOCKET,CORE,CPU | grep ",$cpu_to_search\$" | cut -d"," -f1-2)
55 # Detect which logical cpus belongs to the first physical core
56 # If Hyperthreading is enabled, two cores are returned
57 cpus=$(lscpu --all -pSOCKET,CORE,CPU | grep "$core_to_run")
58 for cpu in ${cpus}; do
60 # shellcheck disable=SC2206
62 if [ ${first_cores_count} -eq 0 ]; then
63 first_cores="${array[2]}"
65 first_cores="${first_cores} ${array[2]}"
68 first_cores_count=$((first_cores_count + 1))
71 [ ${first_cores_count} -eq 0 ] && fatal "Cannot detect first core"
72 taskset_cores=$(echo "${first_cores}" | tr ' ' ',')
76 echo "usage: [options] block_device [other_block_devices]
79 -l : enable latency reporting
82 t/one-core-peak.sh /dev/nvme0n1
83 t/one-core-peak.sh -l /dev/nvme0n1 /dev/nvme1n1
90 while getopts "hl" option; do
99 fatal "Unsupported ${option} option"
104 [ $# -eq 0 ] && fatal "Missing drive(s) as argument"
108 check_drive_exists() {
109 # Ensure the block device exists
110 [ -b $1 ] || fatal "$1 is not a valid block device"
114 [[ ${*} == *"nvme"* ]]
118 # Print a warning if the nvme poll queues aren't enabled
119 is_nvme ${drives} || return
120 poll_queue=$(cat /sys/module/nvme/parameters/poll_queues)
121 [ ${poll_queue} -eq 0 ] && hint "For better performance, you should enable nvme poll queues by setting nvme.poll_queues=32 on the kernel commande line"
128 get_sys_block_dir() {
129 # Returns the /sys/block/ directory of a given block device
131 sys_block_dir="/sys/block/${device_name}"
132 [ -d "${sys_block_dir}" ] || fatal "Cannot find ${sys_block_dir} directory"
133 echo ${sys_block_dir}
136 check_io_scheduler() {
137 # Ensure io_sched is set to none
138 device_name=$(block_dev_name $1)
139 sys_block_dir=$(get_sys_block_dir ${device_name})
140 sched_file="${sys_block_dir}/queue/scheduler"
141 [ -f "${sched_file}" ] || fatal "Cannot find IO scheduler for ${device_name}"
142 grep -q '\[none\]' ${sched_file}
143 if [ $? -ne 0 ]; then
144 info "${device_name}" "set none as io scheduler"
145 echo "none" > ${sched_file}
150 check_sysblock_value() {
151 device_name=$(block_dev_name $1)
152 sys_block_dir=$(get_sys_block_dir ${device_name})
153 target_file="${sys_block_dir}/$2"
155 [ -f "${target_file}" ] || return
156 content=$(cat ${target_file} 2>/dev/null)
157 if [ "${content}" != "${value}" ]; then
158 echo ${value} > ${target_file} 2>/dev/null && info "${device_name}" "${target_file} set to ${value}." || hint "${device_name}: Cannot set ${value} on ${target_file}"
162 compute_nb_threads() {
163 # Increase the number of threads if there is more devices or cores than the default value
164 [ $# -gt ${nb_threads} ] && nb_threads=$#
165 [ ${first_cores_count} -gt ${nb_threads} ] && nb_threads=${first_cores_count}
168 check_scaling_governor() {
169 driver=$(LC_ALL=C cpupower frequency-info |grep "driver:" |awk '{print $2}')
170 if [ -z "${driver}" ]; then
171 hint "Cannot detect processor scaling driver"
174 cpupower frequency-set -g performance >/dev/null 2>&1 || fatal "Cannot set scaling processor governor"
177 check_idle_governor() {
178 filename="/sys/devices/system/cpu/cpuidle/current_governor"
179 if [ ! -f "${filename}" ]; then
180 hint "Cannot detect cpu idle governor"
183 echo "menu" > ${filename} 2>/dev/null || fatal "Cannot set cpu idle governor to menu"
188 device_name=$(block_dev_name $1)
189 device_dir="/sys/block/${device_name}/device/"
190 pci_addr=$(cat ${device_dir}/address)
191 pci_dir="/sys/bus/pci/devices/${pci_addr}/"
192 link_speed=$(cat ${pci_dir}/current_link_speed)
193 irq=$(cat ${pci_dir}/irq)
194 numa=$([ -f ${pci_dir}/numa_node ] && cat ${pci_dir}/numa_node || echo "off")
195 cpus=$(cat ${pci_dir}/local_cpulist)
196 model=$(cat ${device_dir}/model | xargs) #xargs for trimming spaces
197 fw=$(cat ${device_dir}/firmware_rev | xargs) #xargs for trimming spaces
198 serial=$(cat ${device_dir}/serial | xargs) #xargs for trimming spaces
199 info ${device_name} "MODEL=${model} FW=${fw} serial=${serial} PCI=${pci_addr}@${link_speed} IRQ=${irq} NUMA=${numa} CPUS=${cpus} "
200 which nvme &> /dev/null
201 if [ $? -eq 0 ]; then
202 NCQA=$(nvme get-feature -H -f 0x7 ${device} |grep NCQA |cut -d ':' -f 2 | xargs)
203 NSQA=$(nvme get-feature -H -f 0x7 ${device} |grep NSQA |cut -d ':' -f 2 | xargs)
204 power_state=$(nvme get-feature -H -f 0x2 ${device} | grep PS |cut -d ":" -f 2 | xargs)
205 apste=$(nvme get-feature -H -f 0xc ${device} | grep APSTE |cut -d ":" -f 2 | xargs)
206 temp=$(nvme smart-log ${device} |grep 'temperature' |cut -d ':' -f 2 |xargs)
207 info ${device_name} "Temp:${temp}, Autonomous Power State Transition:${apste}, PowerState:${power_state}, Completion Queues:${NCQA}, Submission Queues:${NSQA}"
212 device_name=$(block_dev_name $1)
213 is_nvme $1 && show_nvme $1
216 show_kernel_config_item() {
217 config_item="CONFIG_$1"
218 config_file="/boot/config-$(uname -r)"
219 if [ ! -f "${config_file}" ]; then
220 config_file='/proc/config.gz'
221 if [ ! -f "${config_file}" ]; then
225 status=$(zgrep ${config_item}= ${config_file})
226 if [ -z "${status}" ]; then
227 echo "${config_item}=N"
229 echo "${config_item}=$(echo ${status} | cut -d '=' -f 2)"
234 CPU_MODEL=$(grep -m1 "model name" /proc/cpuinfo | awk '{print substr($0, index($0,$4))}')
235 MEMORY_SPEED=$(dmidecode -t 17 -q | grep -m 1 "Configured Memory Speed: [0-9]" | awk '{print substr($0, index($0,$4))}')
237 info "system" "CPU: ${CPU_MODEL}"
238 info "system" "MEMORY: ${MEMORY_SPEED}"
239 info "system" "KERNEL: ${KERNEL}"
240 for config_item in BLK_CGROUP BLK_WBT_MQ HZ RETPOLINE PAGE_TABLE_ISOLATION; do
241 info "system" "KERNEL: $(show_kernel_config_item ${config_item})"
243 info "system" "KERNEL: $(cat /proc/cmdline)"
244 tsc=$(journalctl -k | grep 'tsc: Refined TSC clocksource calibration:' | awk '{print $11}')
245 if [ -n "${tsc}" ]; then
246 info "system" "TSC: ${tsc} Mhz"
247 tsc=$(echo ${tsc} | tr -d '.')
248 [ -n "${latency_cmdline}" ] && latency_cmdline="-t1 -T${tsc}000"
255 check_binary t/io_uring lscpu grep taskset cpupower awk tr xargs dmidecode
258 info "##################################################"
260 for drive in ${drives}; do
261 check_drive_exists ${drive}
262 check_io_scheduler ${drive}
263 check_sysblock_value ${drive} "queue/iostats" 0 # Ensure iostats are disabled
264 check_sysblock_value ${drive} "queue/nomerges" 2 # Ensure merge are disabled
265 check_sysblock_value ${drive} "queue/io_poll" 1 # Ensure io_poll is enabled
266 check_sysblock_value ${drive} "queue/wbt_lat_usec" 0 # Disabling wbt lat
271 compute_nb_threads ${drives}
272 check_scaling_governor
275 info "##################################################"
278 cmdline="taskset -c ${taskset_cores} t/io_uring -b512 -d128 -c32 -s32 -p1 -F1 -B1 -n${nb_threads} ${latency_cmdline} ${drives}"
279 info "io_uring" "Running ${cmdline}"