Spdk/module/bdev/delay/vbdev_delay.h
Jim Harris 488570ebd4 Replace most BSD 3-clause license text with SPDX identifier.
Many open source projects have moved to using SPDX identifiers
to specify license information, reducing the amount of
boilerplate code in every source file.  This patch replaces
the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause
identifier.

Almost all of these files share the exact same license text,
and this patch only modifies the files that contain the
most common license text.  There can be slight variations
because the third clause contains company names - most say
"Intel Corporation", but there are instances for Nvidia,
Samsung, Eideticom and even "the copyright holder".

Used a bash script to automate replacement of the license text
with SPDX identifier which is checked into scripts/spdx.sh.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: <qun.wan@intel.com>
2022-06-09 07:35:12 +00:00

58 lines
1.7 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright (c) Intel Corporation.
* All rights reserved.
*/
#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 vbdev_name Name of the delay bdev.
* \param cb_fn Function to call after deletion.
* \param cb_arg Argument to pass to cb_fn.
*/
void delete_delay_disk(const char *vbdev_name, 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 */