xref: /spdk/lib/iscsi/tgt_node.h (revision b30d57cdad6d2bc75cc1e4e2ebbcebcb0d98dcfa)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>.
5  *   Copyright (c) Intel Corporation.
6  *   All rights reserved.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above copyright
15  *       notice, this list of conditions and the following disclaimer in
16  *       the documentation and/or other materials provided with the
17  *       distribution.
18  *     * Neither the name of Intel Corporation nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef SPDK_ISCSI_TGT_NODE_H_
36 #define SPDK_ISCSI_TGT_NODE_H_
37 
38 #include "spdk/stdinc.h"
39 
40 #include "iscsi/iscsi.h"
41 
42 struct spdk_iscsi_conn;
43 struct spdk_iscsi_init_grp;
44 struct spdk_iscsi_portal_grp;
45 struct spdk_iscsi_portal;
46 struct spdk_json_write_ctx;
47 
48 #define MAX_TARGET_MAP			256
49 #define SPDK_TN_TAG_MAX			0x0000ffff
50 
51 typedef void (*iscsi_tgt_node_destruct_cb)(void *cb_arg, int rc);
52 
53 struct spdk_iscsi_ig_map {
54 	struct spdk_iscsi_init_grp *ig;
55 	TAILQ_ENTRY(spdk_iscsi_ig_map) tailq;
56 };
57 
58 struct spdk_iscsi_pg_map {
59 	struct spdk_iscsi_portal_grp *pg;
60 	int num_ig_maps;
61 	TAILQ_HEAD(, spdk_iscsi_ig_map) ig_map_head;
62 	char redirect_host[MAX_PORTAL_ADDR + 1];
63 	char redirect_port[MAX_PORTAL_PORT + 1];
64 	TAILQ_ENTRY(spdk_iscsi_pg_map) tailq ;
65 };
66 
67 struct spdk_iscsi_tgt_node {
68 	int num;
69 	char name[MAX_TARGET_NAME + 1];
70 	char alias[MAX_TARGET_NAME + 1];
71 
72 	pthread_mutex_t mutex;
73 
74 	bool disable_chap;
75 	bool require_chap;
76 	bool mutual_chap;
77 	int chap_group;
78 	bool header_digest;
79 	bool data_digest;
80 	int queue_depth;
81 
82 	struct spdk_scsi_dev *dev;
83 	/**
84 	 * Counts number of active iSCSI connections associated with this
85 	 *  target node.
86 	 */
87 	uint32_t num_active_conns;
88 	struct spdk_iscsi_poll_group *pg;
89 
90 	int num_pg_maps;
91 	TAILQ_HEAD(, spdk_iscsi_pg_map) pg_map_head;
92 	TAILQ_ENTRY(spdk_iscsi_tgt_node) tailq;
93 
94 	bool destructed;
95 	struct spdk_poller *destruct_poller;
96 	iscsi_tgt_node_destruct_cb destruct_cb_fn;
97 	void *destruct_cb_arg;
98 };
99 
100 void iscsi_shutdown_tgt_nodes(void);
101 void iscsi_shutdown_tgt_node_by_name(const char *target_name,
102 				     iscsi_tgt_node_destruct_cb cb_fn, void *cb_arg);
103 bool iscsi_tgt_node_is_destructed(struct spdk_iscsi_tgt_node *target);
104 int iscsi_send_tgts(struct spdk_iscsi_conn *conn, const char *iiqn,
105 		    const char *tiqn, uint8_t *data, int alloc_len, int data_len);
106 
107 /*
108  * bdev_name_list and lun_id_list are equal sized arrays of size num_luns.
109  * bdev_name_list refers to the names of the bdevs that will be used for the LUNs on the
110  *  new target node.
111  * lun_id_list refers to the LUN IDs that will be used for the LUNs on the target node.
112  */
113 struct spdk_iscsi_tgt_node *iscsi_tgt_node_construct(int target_index,
114 		const char *name, const char *alias,
115 		int *pg_tag_list, int *ig_tag_list, uint16_t num_maps,
116 		const char *bdev_name_list[], int *lun_id_list, int num_luns,
117 		int queue_depth,
118 		bool disable_chap, bool require_chap, bool mutual_chap, int chap_group,
119 		bool header_digest, bool data_digest);
120 
121 bool iscsi_check_chap_params(bool disable, bool require, bool mutual, int group);
122 
123 int iscsi_target_node_add_pg_ig_maps(struct spdk_iscsi_tgt_node *target,
124 				     int *pg_tag_list, int *ig_tag_list,
125 				     uint16_t num_maps);
126 int iscsi_target_node_remove_pg_ig_maps(struct spdk_iscsi_tgt_node *target,
127 					int *pg_tag_list, int *ig_tag_list,
128 					uint16_t num_maps);
129 int iscsi_tgt_node_redirect(struct spdk_iscsi_tgt_node *target, int pg_tag,
130 			    const char *host, const char *port);
131 bool iscsi_tgt_node_is_redirected(struct spdk_iscsi_conn *conn,
132 				  struct spdk_iscsi_tgt_node *target,
133 				  char *buf, int buf_len);
134 
135 bool iscsi_tgt_node_access(struct spdk_iscsi_conn *conn,
136 			   struct spdk_iscsi_tgt_node *target, const char *iqn,
137 			   const char *addr);
138 struct spdk_iscsi_tgt_node *iscsi_find_tgt_node(const char *target_name);
139 int iscsi_tgt_node_cleanup_luns(struct spdk_iscsi_conn *conn,
140 				struct spdk_iscsi_tgt_node *target);
141 void iscsi_tgt_node_delete_map(struct spdk_iscsi_portal_grp *portal_group,
142 			       struct spdk_iscsi_init_grp *initiator_group);
143 int iscsi_tgt_node_add_lun(struct spdk_iscsi_tgt_node *target,
144 			   const char *bdev_name, int lun_id);
145 int iscsi_tgt_node_set_chap_params(struct spdk_iscsi_tgt_node *target,
146 				   bool disable_chap, bool require_chap,
147 				   bool mutual_chap, int32_t chap_group);
148 void iscsi_tgt_nodes_info_json(struct spdk_json_write_ctx *w);
149 void iscsi_tgt_nodes_config_json(struct spdk_json_write_ctx *w);
150 #endif /* SPDK_ISCSI_TGT_NODE_H_ */
151