diff options
Diffstat (limited to 'src/spdk/module/bdev/delay/vbdev_delay.h')
-rw-r--r-- | src/spdk/module/bdev/delay/vbdev_delay.h | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/src/spdk/module/bdev/delay/vbdev_delay.h b/src/spdk/module/bdev/delay/vbdev_delay.h new file mode 100644 index 000000000..4f88a5e2f --- /dev/null +++ b/src/spdk/module/bdev/delay/vbdev_delay.h @@ -0,0 +1,85 @@ +/*- + * BSD LICENSE + * + * Copyright (c) Intel Corporation. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Intel Corporation nor the names of its + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef SPDK_VBDEV_DELAY_H +#define SPDK_VBDEV_DELAY_H + +#include "spdk/stdinc.h" + +#include "spdk/bdev.h" +#include "spdk/bdev_module.h" + +enum delay_io_type { + DELAY_AVG_READ, + DELAY_P99_READ, + DELAY_AVG_WRITE, + DELAY_P99_WRITE, + DELAY_NONE +}; + +/** + * Create new delay bdev. + * + * \param bdev_name Bdev on which delay vbdev will be created. + * \param vbdev_name Name of the delay bdev. + * \param avg_read_latency Desired typical read latency. + * \param p99_read_latency Desired p99 read latency + * \param avg_write_latency Desired typical write latency. + * \param p99_write_latency Desired p99 write latency + * \return 0 on success, other on failure. + */ +int create_delay_disk(const char *bdev_name, const char *vbdev_name, uint64_t avg_read_latency, + uint64_t p99_read_latency, uint64_t avg_write_latency, uint64_t p99_write_latency); + +/** + * Delete delay bdev. + * + * \param bdev Pointer to delay bdev. + * \param cb_fn Function to call after deletion. + * \param cb_arg Argument to pass to cb_fn. + */ +void delete_delay_disk(struct spdk_bdev *bdev, spdk_bdev_unregister_cb cb_fn, + void *cb_arg); + +/** + * Update one of the latency values for a given delay bdev. + * + * \param delay_name The name of the delay bdev + * \param latency_us The new latency value, in microseconds + * \param type a valid value from the delay_io_type enum + * \return 0 on success, -ENODEV if the bdev cannot be found, and -EINVAL if the bdev is not a delay device. + */ +int vbdev_delay_update_latency_value(char *delay_name, uint64_t latency_us, + enum delay_io_type type); + +#endif /* SPDK_VBDEV_DELAY_H */ |