From a1d0f799c27d9f6a0fc695b089bb84819ff234c6 Mon Sep 17 00:00:00 2001 From: Seth Howell Date: Wed, 14 Aug 2019 08:26:54 -0700 Subject: [PATCH] bdev/delay: point out that latencies are in us. The fact that all latencies were in microseconds was not explicit in all of the help/docs for this bdev. Change-Id: Id13fbb55af62c5f14fd2790e894c4c0646eb25f7 Signed-off-by: Seth Howell Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/465169 Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Shuhei Matsumoto --- doc/jsonrpc.md | 2 +- scripts/rpc.py | 14 +++++++++----- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 4f701498e..700d1464a 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -1718,7 +1718,7 @@ Example response: ## bdev_delay_create {#rpc_bdev_delay_create} Create delay bdev. This bdev type redirects all IO to it's base bdev and inserts a delay on the completion -path to create an artificial drive latency. +path to create an artificial drive latency. All latency values supplied to this bdev should be in microseconds. ### Parameters diff --git a/scripts/rpc.py b/scripts/rpc.py index 75868500a..d93f8cb03 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -432,10 +432,14 @@ if __name__ == "__main__": help='Add a delay bdev on existing bdev') p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True) p.add_argument('-d', '--name', help="Name of the delay bdev", required=True) - p.add_argument('-r', '--avg-read-latency', help="Average latency to apply before completing read ops", required=True, type=int) - p.add_argument('-t', '--nine-nine-read-latency', help="latency to apply to 1 in 100 read ops", required=True, type=int) - p.add_argument('-w', '--avg-write-latency', help="Average latency to apply before completing write ops", required=True, type=int) - p.add_argument('-n', '--nine-nine-write-latency', help="latency to apply to 1 in 100 write ops", required=True, type=int) + p.add_argument('-r', '--avg-read-latency', + help="Average latency to apply before completing read ops (in microseconds)", required=True, type=int) + p.add_argument('-t', '--nine-nine-read-latency', + help="latency to apply to 1 in 100 read ops (in microseconds)", required=True, type=int) + p.add_argument('-w', '--avg-write-latency', + help="Average latency to apply before completing write ops (in microseconds)", required=True, type=int) + p.add_argument('-n', '--nine-nine-write-latency', + help="latency to apply to 1 in 100 write ops (in microseconds)", required=True, type=int) p.set_defaults(func=bdev_delay_create) def bdev_delay_delete(args): @@ -455,7 +459,7 @@ if __name__ == "__main__": help='Update one of the latency values for a given delay bdev') p.add_argument('delay_bdev_name', help='The name of the given delay bdev') p.add_argument('latency_type', help='one of: avg_read, avg_write, p99_read, p99_write. No other values accepted.') - p.add_argument('latency_us', help='new latency value.', type=int) + p.add_argument('latency_us', help='new latency value in microseconds.', type=int) p.set_defaults(func=bdev_delay_update_latency) def construct_error_bdev(args):