xref: /spdk/module/bdev/error/vbdev_error.h (revision 9889ab2dc80e40dae92dcef361d53dcba722043d)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef SPDK_VBDEV_ERROR_H
35 #define SPDK_VBDEV_ERROR_H
36 
37 #include "spdk/stdinc.h"
38 #include "spdk/bdev.h"
39 
40 enum vbdev_error_type {
41 	VBDEV_IO_FAILURE = 1,
42 	VBDEV_IO_PENDING,
43 };
44 
45 typedef void (*spdk_delete_error_complete)(void *cb_arg, int bdeverrno);
46 
47 /**
48  * Create a vbdev on the base bdev to inject error into it.
49  *
50  * \param base_bdev_name Name of the base bdev.
51  * \return 0 on success or negative on failure.
52  */
53 int spdk_vbdev_error_create(const char *base_bdev_name);
54 
55 /**
56  * Delete vbdev used to inject errors.
57  *
58  * \param bdev Pointer to error vbdev.
59  * \param cb_fn Function to call after deletion.
60  * \param cb_arg Arguments to pass to cb_fn.
61  */
62 void spdk_vbdev_error_delete(struct spdk_bdev *vbdev, spdk_delete_error_complete cb_fn,
63 			     void *cb_arg);
64 
65 /**
66  * Inject error to the base bdev. Users can specify which IO type error is injected,
67  * what type of error is injected, and how many errors are injected.
68  *
69  * \param name Name of the base bdev into which error is injected.
70  * \param io_type IO type into which error is injected.
71  * \param error_num Count of injected errors
72  */
73 int spdk_vbdev_error_inject_error(char *name, uint32_t io_type, uint32_t error_type,
74 				  uint32_t error_num);
75 
76 #endif /* SPDK_VBDEV_ERROR_H */
77