Commit a1d0f799 authored by Seth Howell's avatar Seth Howell Committed by Jim Harris
Browse files

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: default avatarSeth Howell <seth.howell@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/465169


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
parent f46b63e3

doc/jsonrpc.md

+1 −1
Original line number Diff line number Diff line
@@ -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

scripts/rpc.py

+9 −5
Original line number Diff line number Diff line
@@ -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):