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;
56 #define AG_TYPE_UNKNOWN 0
57 #define AG_TYPE_NO_AUTHENTICATION 1
58 #define AG_TYPE_CHAP 2
59 #define AG_TYPE_CHAP_MUTUAL 3
62 TAILQ_ENTRY(auth_group) ag_next;
65 struct target *ag_target;
67 TAILQ_HEAD(, auth) ag_auths;
71 TAILQ_ENTRY(portal) p_next;
72 struct portal_group *p_portal_group;
75 struct addrinfo *p_ai;
77 TAILQ_HEAD(, target) p_targets;
82 TAILQ_ENTRY(portal_group) pg_next;
85 struct auth_group *pg_discovery_auth_group;
87 TAILQ_HEAD(, portal) pg_portals;
93 TAILQ_ENTRY(lun_option) lo_next;
100 TAILQ_ENTRY(lun) l_next;
101 TAILQ_HEAD(, lun_option) l_options;
102 struct target *l_target;
115 TAILQ_ENTRY(target) t_next;
116 TAILQ_HEAD(, lun) t_luns;
118 struct auth_group *t_auth_group;
119 struct portal_group *t_portal_group;
125 char *conf_pidfile_path;
126 TAILQ_HEAD(, target) conf_targets;
127 TAILQ_HEAD(, auth_group) conf_auth_groups;
128 TAILQ_HEAD(, portal_group) conf_portal_groups;
133 uint16_t conf_last_portal_group_tag;
134 struct pidfh *conf_pidfh;
137 #define CONN_SESSION_TYPE_NONE 0
138 #define CONN_SESSION_TYPE_DISCOVERY 1
139 #define CONN_SESSION_TYPE_NORMAL 2
141 #define CONN_DIGEST_NONE 0
142 #define CONN_DIGEST_CRC32C 1
145 struct portal *conn_portal;
146 struct target *conn_target;
148 int conn_session_type;
149 char *conn_initiator_name;
150 char *conn_initiator_addr;
151 char *conn_initiator_alias;
153 uint32_t conn_statsn;
154 size_t conn_max_data_segment_length;
155 size_t conn_max_burst_length;
156 int conn_immediate_data;
157 int conn_header_digest;
158 int conn_data_digest;
162 struct connection *pdu_connection;
163 struct iscsi_bhs *pdu_bhs;
168 #define KEYS_MAX 1024
171 char *keys_names[KEYS_MAX];
172 char *keys_values[KEYS_MAX];
174 size_t keys_data_len;
177 struct conf *conf_new(void);
178 struct conf *conf_new_from_file(const char *path);
179 struct conf *conf_new_from_kernel(void);
180 void conf_delete(struct conf *conf);
181 int conf_verify(struct conf *conf);
183 struct auth_group *auth_group_new(struct conf *conf, const char *name);
184 void auth_group_delete(struct auth_group *ag);
185 struct auth_group *auth_group_find(struct conf *conf, const char *name);
187 const struct auth *auth_new_chap(struct auth_group *ag,
188 const char *user, const char *secret);
189 const struct auth *auth_new_chap_mutual(struct auth_group *ag,
190 const char *user, const char *secret,
191 const char *user2, const char *secret2);
192 const struct auth *auth_find(struct auth_group *ag,
195 struct portal_group *portal_group_new(struct conf *conf, const char *name);
196 void portal_group_delete(struct portal_group *pg);
197 struct portal_group *portal_group_find(struct conf *conf, const char *name);
198 int portal_group_add_listen(struct portal_group *pg,
199 const char *listen, bool iser);
201 struct target *target_new(struct conf *conf, const char *iqn);
202 void target_delete(struct target *target);
203 struct target *target_find(struct conf *conf,
206 struct lun *lun_new(struct target *target, int lun_id);
207 void lun_delete(struct lun *lun);
208 struct lun *lun_find(struct target *target, int lun_id);
209 void lun_set_backend(struct lun *lun, const char *value);
210 void lun_set_blocksize(struct lun *lun, size_t value);
211 void lun_set_device_id(struct lun *lun, const char *value);
212 void lun_set_path(struct lun *lun, const char *value);
213 void lun_set_serial(struct lun *lun, const char *value);
214 void lun_set_size(struct lun *lun, size_t value);
215 void lun_set_ctl_lun(struct lun *lun, uint32_t value);
217 struct lun_option *lun_option_new(struct lun *lun,
218 const char *name, const char *value);
219 void lun_option_delete(struct lun_option *clo);
220 struct lun_option *lun_option_find(struct lun *lun, const char *name);
221 void lun_option_set(struct lun_option *clo,
224 void kernel_init(void);
225 int kernel_lun_add(struct lun *lun);
226 int kernel_lun_resize(struct lun *lun);
227 int kernel_lun_remove(struct lun *lun);
228 void kernel_handoff(struct connection *conn);
229 int kernel_port_on(void);
230 int kernel_port_off(void);
231 void kernel_capsicate(void);
236 void kernel_listen(struct addrinfo *ai, bool iser);
237 int kernel_accept(void);
238 void kernel_send(struct pdu *pdu);
239 void kernel_receive(struct pdu *pdu);
241 struct keys *keys_new(void);
242 void keys_delete(struct keys *keys);
243 void keys_load(struct keys *keys, const struct pdu *pdu);
244 void keys_save(struct keys *keys, struct pdu *pdu);
245 const char *keys_find(struct keys *keys, const char *name);
246 int keys_find_int(struct keys *keys, const char *name);
247 void keys_add(struct keys *keys,
248 const char *name, const char *value);
249 void keys_add_int(struct keys *keys,
250 const char *name, int value);
252 struct pdu *pdu_new(struct connection *conn);
253 struct pdu *pdu_new_response(struct pdu *request);
254 void pdu_delete(struct pdu *pdu);
255 void pdu_receive(struct pdu *request);
256 void pdu_send(struct pdu *response);
258 void login(struct connection *conn);
260 void discovery(struct connection *conn);
262 void log_init(int level);
263 void log_set_peer_name(const char *name);
264 void log_set_peer_addr(const char *addr);
265 void log_err(int, const char *, ...)
266 __dead2 __printf0like(2, 3);
267 void log_errx(int, const char *, ...)
268 __dead2 __printf0like(2, 3);
269 void log_warn(const char *, ...) __printf0like(1, 2);
270 void log_warnx(const char *, ...) __printflike(1, 2);
271 void log_debugx(const char *, ...) __printf0like(1, 2);
273 char *checked_strdup(const char *);
274 bool valid_iscsi_name(const char *name);
275 bool timed_out(void);