]> git.ipfire.org Git - thirdparty/kernel/stable.git/blame - include/scsi/libiscsi.h
treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 479
[thirdparty/kernel/stable.git] / include / scsi / libiscsi.h
CommitLineData
1a59d1b8 1/* SPDX-License-Identifier: GPL-2.0-or-later */
7996a778
MC
2/*
3 * iSCSI lib definitions
4 *
5 * Copyright (C) 2006 Red Hat, Inc. All rights reserved.
6 * Copyright (C) 2004 - 2006 Mike Christie
7 * Copyright (C) 2004 - 2005 Dmitry Yusupov
8 * Copyright (C) 2004 - 2005 Alex Aizman
7996a778
MC
9 */
10#ifndef LIBISCSI_H
11#define LIBISCSI_H
12
13#include <linux/types.h>
40753caa 14#include <linux/wait.h>
7996a778 15#include <linux/mutex.h>
f6a57033
AV
16#include <linux/timer.h>
17#include <linux/workqueue.h>
45465487 18#include <linux/kfifo.h>
6dc618cd 19#include <linux/refcount.h>
7996a778
MC
20#include <scsi/iscsi_proto.h>
21#include <scsi/iscsi_if.h>
262ef636 22#include <scsi/scsi_transport_iscsi.h>
7996a778
MC
23
24struct scsi_transport_template;
a4804cd6 25struct scsi_host_template;
7996a778
MC
26struct scsi_device;
27struct Scsi_Host;
6b5d6c44 28struct scsi_target;
7996a778
MC
29struct scsi_cmnd;
30struct socket;
31struct iscsi_transport;
32struct iscsi_cls_session;
33struct iscsi_cls_conn;
34struct iscsi_session;
35struct iscsi_nopin;
a4804cd6 36struct device;
7996a778 37
1548271e 38#define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */
3cf7b233 39#define ISCSI_MGMT_CMDS_MAX 15
7996a778 40
e28f3d5b 41#define ISCSI_DEF_CMD_PER_LUN 32
7996a778
MC
42
43/* Task Mgmt states */
843c0a8a
MC
44enum {
45 TMF_INITIAL,
46 TMF_QUEUED,
47 TMF_SUCCESS,
48 TMF_FAILED,
49 TMF_TIMEDOUT,
50 TMF_NOT_FOUND,
51};
7996a778 52
f8525eb4
AC
53#define ISID_SIZE 6
54
7996a778
MC
55/* Connection suspend "bit" */
56#define ISCSI_SUSPEND_BIT 1
57
262ef636 58#define ISCSI_ITT_MASK 0x1fff
3cf7b233
MC
59#define ISCSI_TOTAL_CMDS_MAX 4096
60/* this must be a power of two greater than ISCSI_MGMT_CMDS_MAX */
61#define ISCSI_TOTAL_CMDS_MIN 16
7996a778 62#define ISCSI_AGE_SHIFT 28
262ef636 63#define ISCSI_AGE_MASK 0xf
7996a778 64
22236961
MC
65#define ISCSI_ADDRESS_BUF_LEN 64
66
da32dd68 67enum {
004d6530
BH
68 /* this is the maximum possible storage for AHSs */
69 ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
70 sizeof(struct iscsi_rlength_ahdr),
da32dd68
OK
71 ISCSI_DIGEST_SIZE = sizeof(__u32),
72};
73
7996a778 74
b6c395ed 75enum {
3bbaaad9 76 ISCSI_TASK_FREE,
b6c395ed
MC
77 ISCSI_TASK_COMPLETED,
78 ISCSI_TASK_PENDING,
79 ISCSI_TASK_RUNNING,
b3cd5050
MC
80 ISCSI_TASK_ABRT_TMF, /* aborted due to TMF */
81 ISCSI_TASK_ABRT_SESS_RECOV, /* aborted due to session recovery */
f41d4721 82 ISCSI_TASK_REQUEUE_SCSIQ, /* qcmd requeueing to scsi-ml */
b6c395ed
MC
83};
84
577577da
MC
85struct iscsi_r2t_info {
86 __be32 ttt; /* copied from R2T */
87 __be32 exp_statsn; /* copied from R2T */
88 uint32_t data_length; /* copied from R2T */
89 uint32_t data_offset; /* copied from R2T */
90 int data_count; /* DATA-Out payload progress */
91 int datasn;
92 /* LLDs should set/update these values */
93 int sent; /* R2T sequence progress */
94};
95
9c19a7d0 96struct iscsi_task {
7996a778 97 /*
004d6530
BH
98 * Because LLDs allocate their hdr differently, this is a pointer
99 * and length to that storage. It must be setup at session
100 * creation time.
7996a778 101 */
577577da 102 struct iscsi_hdr *hdr;
004d6530
BH
103 unsigned short hdr_max;
104 unsigned short hdr_len; /* accumulated size of hdr used */
577577da
MC
105 /* copied values in case we need to send tmfs */
106 itt_t hdr_itt;
107 __be32 cmdsn;
516f43a2 108 struct scsi_lun lun;
577577da 109
7996a778 110 int itt; /* this ITT */
7996a778 111
857ae0bd 112 unsigned imm_count; /* imm-data (bytes) */
ffd0436e 113 /* offset in unsolicited stream (bytes); */
577577da 114 struct iscsi_r2t_info unsol_r2t;
3e5c28ad 115 char *data; /* mgmt payload */
577577da 116 unsigned data_count;
7996a778 117 struct scsi_cmnd *sc; /* associated SCSI cmd*/
7996a778 118 struct iscsi_conn *conn; /* used connection */
7996a778 119
d355e57d
MC
120 /* data processing tracking */
121 unsigned long last_xfer;
122 unsigned long last_timeout;
123 bool have_checked_conn;
55e51eda
SG
124
125 /* T10 protection information */
126 bool protected;
127
b6c395ed
MC
128 /* state set/tested under session->lock */
129 int state;
6dc618cd 130 refcount_t refcount;
7996a778
MC
131 struct list_head running; /* running cmd list */
132 void *dd_data; /* driver/transport data */
133};
134
577577da
MC
135static inline int iscsi_task_has_unsol_data(struct iscsi_task *task)
136{
137 return task->unsol_r2t.data_length > task->unsol_r2t.sent;
138}
139
9c19a7d0 140static inline void* iscsi_next_hdr(struct iscsi_task *task)
004d6530 141{
9c19a7d0 142 return (void*)task->hdr + task->hdr_len;
004d6530
BH
143}
144
6eabafbe
MC
145/* Connection's states */
146enum {
147 ISCSI_CONN_INITIAL_STAGE,
148 ISCSI_CONN_STARTED,
149 ISCSI_CONN_STOPPED,
150 ISCSI_CONN_CLEANUP_WAIT,
151};
152
7996a778
MC
153struct iscsi_conn {
154 struct iscsi_cls_conn *cls_conn; /* ptr to class connection */
155 void *dd_data; /* iscsi_transport data */
156 struct iscsi_session *session; /* parent session */
7996a778
MC
157 /*
158 * conn_stop() flag: stop to recover, stop to terminate
159 */
160 int stop_stage;
f6d5180c
MC
161 struct timer_list transport_timer;
162 unsigned long last_recv;
163 unsigned long last_ping;
164 int ping_timeout;
165 int recv_timeout;
9c19a7d0 166 struct iscsi_task *ping_task;
7996a778
MC
167
168 /* iSCSI connection-wide sequencing */
169 uint32_t exp_statsn;
f8525eb4 170 uint32_t statsn;
7996a778
MC
171
172 /* control data */
173 int id; /* CID */
7996a778 174 int c_stage; /* connection state */
c8dc1e52
MC
175 /*
176 * Preallocated buffer for pdus that have data but do not
177 * originate from scsi-ml. We never have two pdus using the
178 * buffer at the same time. It is only allocated to
179 * the default max recv size because the pdus we support
180 * should always fit in this buffer
181 */
182 char *data;
9c19a7d0
MC
183 struct iscsi_task *login_task; /* mtask used for login/text */
184 struct iscsi_task *task; /* xmit task in progress */
7996a778
MC
185
186 /* xmit */
6f8830f5 187 spinlock_t taskqueuelock; /* protects the next three lists */
843c0a8a 188 struct list_head mgmtqueue; /* mgmt (control) xmit queue */
3bbaaad9 189 struct list_head cmdqueue; /* data-path cmd queue */
843c0a8a 190 struct list_head requeue; /* tasks needing another run */
7996a778 191 struct work_struct xmitwork; /* per-conn. xmit workqueue */
7996a778
MC
192 unsigned long suspend_tx; /* suspend Tx */
193 unsigned long suspend_rx; /* suspend Rx */
194
195 /* abort */
196 wait_queue_head_t ehwait; /* used in eh_abort() */
197 struct iscsi_tm tmhdr;
843c0a8a
MC
198 struct timer_list tmf_timer;
199 int tmf_state; /* see TMF_INITIAL, etc.*/
7996a778
MC
200
201 /* negotiated params */
857ae0bd
MC
202 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
203 unsigned max_xmit_dlength; /* target_max_recv_dsl */
7996a778
MC
204 int hdrdgst_en;
205 int datadgst_en;
a54a52ca
MC
206 int ifmarker_en;
207 int ofmarker_en;
208 /* values userspace uses to id a conn */
209 int persistent_port;
210 char *persistent_address;
7996a778 211
f8525eb4
AC
212 unsigned max_segment_size;
213 unsigned tcp_xmit_wsf;
214 unsigned tcp_recv_wsf;
215 uint16_t keepalive_tmo;
216 uint16_t local_port;
217 uint8_t tcp_timestamp_stat;
218 uint8_t tcp_nagle_disable;
219 uint8_t tcp_wsf_disable;
220 uint8_t tcp_timer_scale;
221 uint8_t tcp_timestamp_en;
222 uint8_t fragment_disable;
223 uint8_t ipv4_tos;
224 uint8_t ipv6_traffic_class;
225 uint8_t ipv6_flow_label;
226 uint8_t is_fw_assigned_ipv6;
ae56ff40 227 char *local_ipaddr;
f8525eb4 228
7996a778
MC
229 /* MIB-statistics */
230 uint64_t txdata_octets;
231 uint64_t rxdata_octets;
232 uint32_t scsicmd_pdus_cnt;
233 uint32_t dataout_pdus_cnt;
234 uint32_t scsirsp_pdus_cnt;
235 uint32_t datain_pdus_cnt;
236 uint32_t r2t_pdus_cnt;
237 uint32_t tmfcmd_pdus_cnt;
238 int32_t tmfrsp_pdus_cnt;
239
240 /* custom statistics */
241 uint32_t eh_abort_cnt;
87528227 242 uint32_t fmr_unalign_cnt;
7996a778
MC
243};
244
6320377f 245struct iscsi_pool {
45465487 246 struct kfifo queue; /* FIFO Queue */
7996a778
MC
247 void **pool; /* Pool of elements */
248 int max; /* Max number of elements */
249};
250
6eabafbe
MC
251/* Session's states */
252enum {
253 ISCSI_STATE_FREE = 1,
254 ISCSI_STATE_LOGGED_IN,
255 ISCSI_STATE_FAILED,
256 ISCSI_STATE_TERMINATE,
257 ISCSI_STATE_IN_RECOVERY,
258 ISCSI_STATE_RECOVERY_FAILED,
259 ISCSI_STATE_LOGGING_OUT,
260};
261
7996a778 262struct iscsi_session {
75613521 263 struct iscsi_cls_session *cls_session;
6724add1
MC
264 /*
265 * Syncs up the scsi eh thread with the iscsi eh thread when sending
266 * task management functions. This must be taken before the session
267 * and recv lock.
268 */
269 struct mutex eh_mutex;
270
7996a778
MC
271 /* iSCSI session-wide sequencing */
272 uint32_t cmdsn;
273 uint32_t exp_cmdsn;
274 uint32_t max_cmdsn;
275
e0726407
MC
276 /* This tracks the reqs queued into the initiator */
277 uint32_t queued_cmdsn;
278
7996a778 279 /* configuration */
f6d5180c
MC
280 int abort_timeout;
281 int lu_reset_timeout;
3fe5ae8b 282 int tgt_reset_timeout;
7996a778 283 int initial_r2t_en;
1304be5f 284 unsigned short max_r2t;
7996a778 285 int imm_data_en;
857ae0bd
MC
286 unsigned first_burst;
287 unsigned max_burst;
7996a778
MC
288 int time2wait;
289 int time2retain;
290 int pdu_inorder_en;
291 int dataseq_inorder_en;
292 int erl;
843c0a8a 293 int fast_abort;
a54a52ca 294 int tpgt;
b2c64167
MC
295 char *username;
296 char *username_in;
297 char *password;
298 char *password_in;
a54a52ca 299 char *targetname;
3c5c4801 300 char *targetalias;
88dfd340
MC
301 char *ifacename;
302 char *initiatorname;
3b9373e9
EW
303 char *boot_root;
304 char *boot_nic;
305 char *boot_target;
f8525eb4
AC
306 char *portal_type;
307 char *discovery_parent_type;
308 uint16_t discovery_parent_idx;
309 uint16_t def_taskmgmt_tmo;
310 uint16_t tsid;
311 uint8_t auto_snd_tgt_disable;
312 uint8_t discovery_sess;
313 uint8_t chap_auth_en;
314 uint8_t discovery_logout_en;
315 uint8_t bidi_chap_en;
316 uint8_t discovery_auth_optional;
317 uint8_t isid[ISID_SIZE];
3b9373e9 318
7996a778
MC
319 /* control data */
320 struct iscsi_transport *tt;
321 struct Scsi_Host *host;
322 struct iscsi_conn *leadconn; /* leading connection */
659743b0
SP
323 /* Between the forward and the backward locks exists a strict locking
324 * hierarchy. The mutual exclusion zone protected by the forward lock
325 * can enclose the mutual exclusion zone protected by the backward lock
326 * but not vice versa.
327 */
328 spinlock_t frwd_lock; /* protects session state, *
329 * cmdsn, queued_cmdsn *
7996a778 330 * session resources: *
659743b0
SP
331 * - cmdpool kfifo_out , *
332 * - mgmtpool, */
333 spinlock_t back_lock; /* protects cmdsn_exp *
334 * cmdsn_max, *
335 * cmdpool kfifo_in */
7996a778 336 int state; /* session state */
7996a778
MC
337 int age; /* counts session re-opens */
338
3e5c28ad 339 int scsi_cmds_max; /* max scsi commands */
7996a778 340 int cmds_max; /* size of cmds array */
9c19a7d0 341 struct iscsi_task **cmds; /* Original Cmds arr */
6320377f 342 struct iscsi_pool cmdpool; /* PDU's pool */
b8b9e1b8 343 void *dd_data; /* LLD private data */
7996a778
MC
344};
345
e5bd7b54
MC
346enum {
347 ISCSI_HOST_SETUP,
348 ISCSI_HOST_REMOVED,
349};
350
75613521
MC
351struct iscsi_host {
352 char *initiatorname;
353 /* hw address or netdev iscsi connection is bound to */
354 char *hwaddress;
355 char *netdev;
e5bd7b54
MC
356
357 wait_queue_head_t session_removal_wq;
358 /* protects sessions and state */
359 spinlock_t lock;
360 int num_sessions;
361 int state;
32ae763e
MC
362
363 struct workqueue_struct *workq;
364 char workq_name[20];
75613521
MC
365};
366
7996a778
MC
367/*
368 * scsi host template
369 */
7996a778 370extern int iscsi_eh_abort(struct scsi_cmnd *sc);
309ce156
JK
371extern int iscsi_eh_recover_target(struct scsi_cmnd *sc);
372extern int iscsi_eh_session_reset(struct scsi_cmnd *sc);
843c0a8a 373extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
f41d4721 374extern int iscsi_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *sc);
b6a05c82 375extern enum blk_eh_timer_return iscsi_eh_cmd_timed_out(struct scsi_cmnd *sc);
0801c242 376
0801c242
MC
377/*
378 * iSCSI host helpers.
379 */
5d91e209
MC
380#define iscsi_host_priv(_shost) \
381 (shost_priv(_shost) + sizeof(struct iscsi_host))
382
0801c242
MC
383extern int iscsi_host_set_param(struct Scsi_Host *shost,
384 enum iscsi_host_param param, char *buf,
385 int buflen);
386extern int iscsi_host_get_param(struct Scsi_Host *shost,
387 enum iscsi_host_param param, char *buf);
a4804cd6
MC
388extern int iscsi_host_add(struct Scsi_Host *shost, struct device *pdev);
389extern struct Scsi_Host *iscsi_host_alloc(struct scsi_host_template *sht,
4d108350 390 int dd_data_size,
32ae763e 391 bool xmit_can_sleep);
a4804cd6
MC
392extern void iscsi_host_remove(struct Scsi_Host *shost);
393extern void iscsi_host_free(struct Scsi_Host *shost);
6b5d6c44 394extern int iscsi_target_alloc(struct scsi_target *starget);
7996a778
MC
395
396/*
397 * session management
398 */
399extern struct iscsi_cls_session *
75613521 400iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost,
b8b9e1b8 401 uint16_t, int, int, uint32_t, unsigned int);
7996a778 402extern void iscsi_session_teardown(struct iscsi_cls_session *);
7996a778 403extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
a54a52ca
MC
404extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
405 enum iscsi_param param, char *buf, int buflen);
406extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
407 enum iscsi_param param, char *buf);
7996a778 408
322d739d 409#define iscsi_session_printk(prefix, _sess, fmt, a...) \
75613521 410 iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a)
322d739d 411
7996a778
MC
412/*
413 * connection management
414 */
415extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
5d91e209 416 int, uint32_t);
7996a778
MC
417extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
418extern int iscsi_conn_start(struct iscsi_cls_conn *);
419extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
420extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
421 int);
422extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
40a06e75 423extern void iscsi_session_failure(struct iscsi_session *session,
e5bd7b54 424 enum iscsi_err err);
a54a52ca
MC
425extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
426 enum iscsi_param param, char *buf);
00f3708e
MC
427extern int iscsi_conn_get_addr_param(struct sockaddr_storage *addr,
428 enum iscsi_param param, char *buf);
5af3e91d 429extern void iscsi_suspend_tx(struct iscsi_conn *conn);
661134ad 430extern void iscsi_suspend_queue(struct iscsi_conn *conn);
32ae763e 431extern void iscsi_conn_queue_work(struct iscsi_conn *conn);
7996a778 432
322d739d 433#define iscsi_conn_printk(prefix, _c, fmt, a...) \
5af3e91d
MC
434 iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \
435 fmt, ##a)
322d739d 436
7996a778
MC
437/*
438 * pdu and task processing
439 */
77a23c21 440extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
577577da
MC
441extern void iscsi_prep_data_out_pdu(struct iscsi_task *task,
442 struct iscsi_r2t_info *r2t,
443 struct iscsi_data *hdr);
7996a778
MC
444extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
445 char *, uint32_t);
446extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
447 char *, int);
913e5bf4
MC
448extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
449 char *, int);
0af967f5 450extern int iscsi_verify_itt(struct iscsi_conn *, itt_t);
9c19a7d0 451extern struct iscsi_task *iscsi_itt_to_ctask(struct iscsi_conn *, itt_t);
8f9256ce 452extern struct iscsi_task *iscsi_itt_to_task(struct iscsi_conn *, itt_t);
9c19a7d0
MC
453extern void iscsi_requeue_task(struct iscsi_task *task);
454extern void iscsi_put_task(struct iscsi_task *task);
8eea2f55 455extern void __iscsi_put_task(struct iscsi_task *task);
913e5bf4 456extern void __iscsi_get_task(struct iscsi_task *task);
4c0ba5d2
MC
457extern void iscsi_complete_scsi_task(struct iscsi_task *task,
458 uint32_t exp_cmdsn, uint32_t max_cmdsn);
7996a778
MC
459
460/*
461 * generic helpers
462 */
6320377f
OK
463extern void iscsi_pool_free(struct iscsi_pool *);
464extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int);
adaf6990 465extern int iscsi_switch_str_param(char **, char *);
7996a778 466
004d6530
BH
467/*
468 * inline functions to deal with padding.
469 */
470static inline unsigned int
471iscsi_padded(unsigned int len)
472{
473 return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
474}
475
476static inline unsigned int
477iscsi_padding(unsigned int len)
478{
479 len &= (ISCSI_PAD_LEN - 1);
480 if (len)
481 len = ISCSI_PAD_LEN - len;
482 return len;
483}
484
7996a778 485#endif