xref: /spdk/module/bdev/error/vbdev_error.h (revision e55c9a81251968acc91e4d44169353be1987a3e4)

/*   SPDX-License-Identifier: BSD-3-Clause
 *   Copyright (C) 2017 Intel Corporation.
 *   All rights reserved.
 */

#ifndef SPDK_VBDEV_ERROR_H
#define SPDK_VBDEV_ERROR_H

#include "spdk/stdinc.h"
#include "spdk/bdev.h"
#include "spdk/uuid.h"

enum vbdev_error_type {
	VBDEV_IO_NO_ERROR = 0,
	VBDEV_IO_FAILURE,
	VBDEV_IO_PENDING,
	VBDEV_IO_CORRUPT_DATA,
	VBDEV_IO_NOMEM,
};

typedef void (*spdk_delete_error_complete)(void *cb_arg, int bdeverrno);

/**
 * Create a vbdev on the base bdev to inject error into it.
 *
 * \param base_bdev_name Name of the base bdev.
 * \param uuid Optional UUID to assign to the bdev.
 * \return 0 on success or negative on failure.
 */
int vbdev_error_create(const char *base_bdev_name, const struct spdk_uuid *uuid);

/**
 * Delete vbdev used to inject errors.
 *
 * \param error_vbdev_name Name of the error vbdev.
 * \param cb_fn Function to call after deletion.
 * \param cb_arg Arguments to pass to cb_fn.
 */
void vbdev_error_delete(const char *error_vbdev_name, spdk_delete_error_complete cb_fn,
			void *cb_arg);

struct vbdev_error_inject_opts {
	uint32_t io_type;
	uint32_t error_type;
	uint32_t error_num;
	uint64_t error_qd;
	uint64_t corrupt_offset;
	uint8_t corrupt_value;
};

/**
 * Inject error to the base bdev. Users can specify which IO type error is injected,
 * what type of error is injected, and how many errors are injected.
 *
 * \param name Name of the base bdev into which error is injected.
 * \param opts Options for error injection.
 */
int vbdev_error_inject_error(char *name, const struct vbdev_error_inject_opts *opts);

#endif /* SPDK_VBDEV_ERROR_H */