xref: /spdk/module/bdev/null/bdev_null.h (revision 927f1fd57bd004df581518466ec4c1b8083e5d23)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation. All rights reserved.
5  *   Copyright (c) 2019 Mellanox Technologies LTD. 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_BDEV_NULL_H
35 #define SPDK_BDEV_NULL_H
36 
37 #include "spdk/stdinc.h"
38 
39 typedef void (*spdk_delete_null_complete)(void *cb_arg, int bdeverrno);
40 
41 struct spdk_bdev;
42 struct spdk_uuid;
43 
44 struct spdk_null_bdev_opts {
45 	const char *name;
46 	const struct spdk_uuid *uuid;
47 	uint64_t num_blocks;
48 	uint32_t block_size;
49 	uint32_t md_size;
50 	bool md_interleave;
51 	enum spdk_dif_type dif_type;
52 	bool dif_is_head_of_md;
53 };
54 
55 int bdev_null_create(struct spdk_bdev **bdev, const struct spdk_null_bdev_opts *opts);
56 
57 /**
58  * Delete null bdev.
59  *
60  * \param bdev_name Name of null bdev.
61  * \param cb_fn Function to call after deletion.
62  * \param cb_arg Argument to pass to cb_fn.
63  */
64 void bdev_null_delete(const char *bdev_name, spdk_delete_null_complete cb_fn,
65 		      void *cb_arg);
66 /**
67  * Resize null bdev.
68  *
69  * \param bdev_name Name of null bdev.
70  * \param new_size_in_mb The new size in MiB for this bdev
71  */
72 int bdev_null_resize(const char *bdev_name, const uint64_t new_size_in_mb);
73 
74 #endif /* SPDK_BDEV_NULL_H */
75