2 * Copyright (c) 2012 The FreeBSD Foundation
5 * This software was developed by Edward Tomasz Napierala under sponsorship
6 * from the FreeBSD Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #include <sys/queue.h>
39 #define DEFAULT_CONFIG_PATH "/etc/ctl.conf"
40 #define DEFAULT_PIDFILE "/var/run/ctld.pid"
41 #define DEFAULT_BLOCKSIZE 512
43 #define MAX_NAME_LEN 223
44 #define MAX_DATA_SEGMENT_LENGTH (128 * 1024)
45 #define MAX_BURST_LENGTH 16776192
48 TAILQ_ENTRY(auth) a_next;
49 struct auth_group *a_auth_group;
53 char *a_mutual_secret;
57 TAILQ_ENTRY(auth_name) an_next;
58 struct auth_group *an_auth_group;
59 char *an_initator_name;
63 TAILQ_ENTRY(auth_portal) ap_next;
64 struct auth_group *ap_auth_group;
65 char *ap_initator_portal;
68 #define AG_TYPE_UNKNOWN 0
69 #define AG_TYPE_NO_AUTHENTICATION 1
70 #define AG_TYPE_CHAP 2
71 #define AG_TYPE_CHAP_MUTUAL 3
74 TAILQ_ENTRY(auth_group) ag_next;
77 struct target *ag_target;
79 TAILQ_HEAD(, auth) ag_auths;
80 TAILQ_HEAD(, auth_name) ag_names;
81 TAILQ_HEAD(, auth_portal) ag_portals;
85 TAILQ_ENTRY(portal) p_next;
86 struct portal_group *p_portal_group;
89 struct addrinfo *p_ai;
91 TAILQ_HEAD(, target) p_targets;
96 TAILQ_ENTRY(portal_group) pg_next;
99 struct auth_group *pg_discovery_auth_group;
101 TAILQ_HEAD(, portal) pg_portals;
107 TAILQ_ENTRY(lun_option) lo_next;
114 TAILQ_ENTRY(lun) l_next;
115 TAILQ_HEAD(, lun_option) l_options;
116 struct target *l_target;
129 TAILQ_ENTRY(target) t_next;
130 TAILQ_HEAD(, lun) t_luns;
132 struct auth_group *t_auth_group;
133 struct portal_group *t_portal_group;
139 char *conf_pidfile_path;
140 TAILQ_HEAD(, target) conf_targets;
141 TAILQ_HEAD(, auth_group) conf_auth_groups;
142 TAILQ_HEAD(, portal_group) conf_portal_groups;
147 uint16_t conf_last_portal_group_tag;
148 struct pidfh *conf_pidfh;
150 bool conf_default_pg_defined;
151 bool conf_default_ag_defined;
154 #define CONN_SESSION_TYPE_NONE 0
155 #define CONN_SESSION_TYPE_DISCOVERY 1
156 #define CONN_SESSION_TYPE_NORMAL 2
158 #define CONN_DIGEST_NONE 0
159 #define CONN_DIGEST_CRC32C 1
162 struct portal *conn_portal;
163 struct target *conn_target;
165 int conn_session_type;
166 char *conn_initiator_name;
167 char *conn_initiator_addr;
168 char *conn_initiator_alias;
170 uint32_t conn_statsn;
171 size_t conn_max_data_segment_length;
172 size_t conn_max_burst_length;
173 int conn_immediate_data;
174 int conn_header_digest;
175 int conn_data_digest;
179 struct connection *pdu_connection;
180 struct iscsi_bhs *pdu_bhs;
185 #define KEYS_MAX 1024
188 char *keys_names[KEYS_MAX];
189 char *keys_values[KEYS_MAX];
191 size_t keys_data_len;
194 struct conf *conf_new(void);
195 struct conf *conf_new_from_file(const char *path);
196 struct conf *conf_new_from_kernel(void);
197 void conf_delete(struct conf *conf);
198 int conf_verify(struct conf *conf);
200 struct auth_group *auth_group_new(struct conf *conf, const char *name);
201 void auth_group_delete(struct auth_group *ag);
202 struct auth_group *auth_group_find(struct conf *conf, const char *name);
203 int auth_group_set_type_str(struct auth_group *ag,
206 const struct auth *auth_new_chap(struct auth_group *ag,
207 const char *user, const char *secret);
208 const struct auth *auth_new_chap_mutual(struct auth_group *ag,
209 const char *user, const char *secret,
210 const char *user2, const char *secret2);
211 const struct auth *auth_find(struct auth_group *ag,
214 const struct auth_name *auth_name_new(struct auth_group *ag,
215 const char *initiator_name);
216 bool auth_name_defined(const struct auth_group *ag);
217 const struct auth_name *auth_name_find(const struct auth_group *ag,
218 const char *initiator_name);
220 const struct auth_portal *auth_portal_new(struct auth_group *ag,
221 const char *initiator_portal);
222 bool auth_portal_defined(const struct auth_group *ag);
223 const struct auth_portal *auth_portal_find(const struct auth_group *ag,
224 const char *initiator_portal);
226 struct portal_group *portal_group_new(struct conf *conf, const char *name);
227 void portal_group_delete(struct portal_group *pg);
228 struct portal_group *portal_group_find(struct conf *conf, const char *name);
229 int portal_group_add_listen(struct portal_group *pg,
230 const char *listen, bool iser);
232 struct target *target_new(struct conf *conf, const char *name);
233 void target_delete(struct target *target);
234 struct target *target_find(struct conf *conf,
237 struct lun *lun_new(struct target *target, int lun_id);
238 void lun_delete(struct lun *lun);
239 struct lun *lun_find(struct target *target, int lun_id);
240 void lun_set_backend(struct lun *lun, const char *value);
241 void lun_set_blocksize(struct lun *lun, size_t value);
242 void lun_set_device_id(struct lun *lun, const char *value);
243 void lun_set_path(struct lun *lun, const char *value);
244 void lun_set_serial(struct lun *lun, const char *value);
245 void lun_set_size(struct lun *lun, size_t value);
246 void lun_set_ctl_lun(struct lun *lun, uint32_t value);
248 struct lun_option *lun_option_new(struct lun *lun,
249 const char *name, const char *value);
250 void lun_option_delete(struct lun_option *clo);
251 struct lun_option *lun_option_find(struct lun *lun, const char *name);
252 void lun_option_set(struct lun_option *clo,
255 void kernel_init(void);
256 int kernel_lun_add(struct lun *lun);
257 int kernel_lun_resize(struct lun *lun);
258 int kernel_lun_remove(struct lun *lun);
259 void kernel_handoff(struct connection *conn);
260 int kernel_port_on(void);
261 int kernel_port_off(void);
262 void kernel_capsicate(void);
267 void kernel_listen(struct addrinfo *ai, bool iser);
268 int kernel_accept(void);
269 void kernel_send(struct pdu *pdu);
270 void kernel_receive(struct pdu *pdu);
272 struct keys *keys_new(void);
273 void keys_delete(struct keys *keys);
274 void keys_load(struct keys *keys, const struct pdu *pdu);
275 void keys_save(struct keys *keys, struct pdu *pdu);
276 const char *keys_find(struct keys *keys, const char *name);
277 int keys_find_int(struct keys *keys, const char *name);
278 void keys_add(struct keys *keys,
279 const char *name, const char *value);
280 void keys_add_int(struct keys *keys,
281 const char *name, int value);
283 struct pdu *pdu_new(struct connection *conn);
284 struct pdu *pdu_new_response(struct pdu *request);
285 void pdu_delete(struct pdu *pdu);
286 void pdu_receive(struct pdu *request);
287 void pdu_send(struct pdu *response);
289 void login(struct connection *conn);
291 void discovery(struct connection *conn);
293 void log_init(int level);
294 void log_set_peer_name(const char *name);
295 void log_set_peer_addr(const char *addr);
296 void log_err(int, const char *, ...)
297 __dead2 __printf0like(2, 3);
298 void log_errx(int, const char *, ...)
299 __dead2 __printf0like(2, 3);
300 void log_warn(const char *, ...) __printf0like(1, 2);
301 void log_warnx(const char *, ...) __printflike(1, 2);
302 void log_debugx(const char *, ...) __printf0like(1, 2);
304 char *checked_strdup(const char *);
305 bool valid_iscsi_name(const char *name);
306 bool timed_out(void);