xref: /spdk/module/bdev/ftl/bdev_ftl.h (revision 712a3f69d32632bf6c862f00200f7f437d3f7529)
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_BDEV_FTL_H
35 #define SPDK_BDEV_FTL_H
36 
37 #include "spdk/stdinc.h"
38 #include "spdk/bdev_module.h"
39 #include "spdk/ftl.h"
40 
41 struct spdk_bdev;
42 struct spdk_uuid;
43 
44 struct ftl_bdev_info {
45 	const char		*name;
46 	struct spdk_uuid	uuid;
47 };
48 
49 struct ftl_bdev_init_opts {
50 	/* Bdev's name */
51 	const char				*name;
52 	/* Base bdev's name */
53 	const char				*base_bdev;
54 	/* Write buffer bdev's name */
55 	const char				*cache_bdev;
56 	/* Bdev's mode */
57 	uint32_t				mode;
58 	/* UUID if device is restored from SSD */
59 	struct spdk_uuid			uuid;
60 	/* FTL library configuration */
61 	struct spdk_ftl_conf			ftl_conf;
62 };
63 
64 typedef void (*ftl_bdev_init_fn)(const struct ftl_bdev_info *, void *, int);
65 
66 int	bdev_ftl_create_bdev(const struct ftl_bdev_init_opts *bdev_opts,
67 			     ftl_bdev_init_fn cb, void *cb_arg);
68 void	bdev_ftl_delete_bdev(const char *name, spdk_bdev_unregister_cb cb_fn, void *cb_arg);
69 
70 #endif /* SPDK_BDEV_FTL_H */
71