xref: /spdk/module/bdev/iscsi/bdev_iscsi.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_BDEV_ISCSI_H
35 #define SPDK_BDEV_ISCSI_H
36 
37 #include "spdk/bdev.h"
38 
39 typedef void (*spdk_delete_iscsi_complete)(void *cb_arg, int bdeverrno);
40 
41 /**
42  * SPDK bdev iSCSI callback type.
43  *
44  * \param cb_arg Completion callback custom arguments
45  * \param bdev created bdev
46  * \param status operation status. Zero on success.
47  */
48 typedef void (*spdk_bdev_iscsi_create_cb)(void *cb_arg, struct spdk_bdev *bdev, int status);
49 
50 /**
51  * Create new iSCSI bdev.
52  *
53  * \warning iSCSI URL allow providing login and password. Be careful because
54  * they will show up in configuration dump.
55  *
56  * \param name name for new bdev.
57  * \param initiator_iqn connection iqn name we identify to target as
58  * \param url iSCSI URL string.
59  * \param cb_fn Completion callback
60  * \param cb_arg Completion callback custom arguments
61  * \return 0 on success or negative error code. If success bdev with provided name was created.
62  */
63 int create_iscsi_disk(const char *bdev_name, const char *initiator_iqn, const char *url,
64 		      spdk_bdev_iscsi_create_cb cb_fn, void *cb_arg);
65 
66 /**
67  * Delete iSCSI bdev.
68  *
69  * \param bdev Pointer to iSCSI bdev.
70  * \param cb_fn Completion callback
71  * \param cb_arg Completion callback custom arguments
72  */
73 void delete_iscsi_disk(struct spdk_bdev *bdev, spdk_delete_iscsi_complete cb_fn, void *cb_arg);
74 
75 #endif /* SPDK_BDEV_ISCSI_H */
76