blob: 4d1c46aac3319de315239dc1e1908c3204a8ad20 [file] [log] [blame]
Mike Christie7996a772006-04-06 21:13:41 -05001/*
2 * iSCSI lib definitions
3 *
4 * Copyright (C) 2006 Red Hat, Inc. All rights reserved.
5 * Copyright (C) 2004 - 2006 Mike Christie
6 * Copyright (C) 2004 - 2005 Dmitry Yusupov
7 * Copyright (C) 2004 - 2005 Alex Aizman
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 */
23#ifndef LIBISCSI_H
24#define LIBISCSI_H
25
26#include <linux/types.h>
Mike Christie40753ca2008-05-21 15:53:56 -050027#include <linux/wait.h>
Mike Christie7996a772006-04-06 21:13:41 -050028#include <linux/mutex.h>
Al Virof6a57032006-10-18 01:47:25 -040029#include <linux/timer.h>
30#include <linux/workqueue.h>
Stefani Seibold45465482009-12-21 14:37:26 -080031#include <linux/kfifo.h>
Mike Christie7996a772006-04-06 21:13:41 -050032#include <scsi/iscsi_proto.h>
33#include <scsi/iscsi_if.h>
Mike Christie262ef632008-12-02 00:32:13 -060034#include <scsi/scsi_transport_iscsi.h>
Mike Christie7996a772006-04-06 21:13:41 -050035
36struct scsi_transport_template;
Mike Christiea4804cd2008-05-21 15:54:00 -050037struct scsi_host_template;
Mike Christie7996a772006-04-06 21:13:41 -050038struct scsi_device;
39struct Scsi_Host;
Mike Christie6b5d6c42009-04-21 15:32:32 -050040struct scsi_target;
Mike Christie7996a772006-04-06 21:13:41 -050041struct scsi_cmnd;
42struct socket;
43struct iscsi_transport;
44struct iscsi_cls_session;
45struct iscsi_cls_conn;
46struct iscsi_session;
47struct iscsi_nopin;
Mike Christiea4804cd2008-05-21 15:54:00 -050048struct device;
Mike Christie7996a772006-04-06 21:13:41 -050049
Mike Christie15482712007-05-30 12:57:19 -050050#define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */
Mike Christie3cf7b232008-05-21 15:54:17 -050051#define ISCSI_MGMT_CMDS_MAX 15
Mike Christie7996a772006-04-06 21:13:41 -050052
Mike Christiee28f3d52009-03-05 14:46:01 -060053#define ISCSI_DEF_CMD_PER_LUN 32
Mike Christie7996a772006-04-06 21:13:41 -050054
55/* Task Mgmt states */
Mike Christie843c0a82007-12-13 12:43:20 -060056enum {
57 TMF_INITIAL,
58 TMF_QUEUED,
59 TMF_SUCCESS,
60 TMF_FAILED,
61 TMF_TIMEDOUT,
62 TMF_NOT_FOUND,
63};
Mike Christie7996a772006-04-06 21:13:41 -050064
Adheer Chandravanshif8525eb2013-07-01 05:54:12 -040065#define ISID_SIZE 6
66
Mike Christie7996a772006-04-06 21:13:41 -050067/* Connection suspend "bit" */
68#define ISCSI_SUSPEND_BIT 1
69
Mike Christie262ef632008-12-02 00:32:13 -060070#define ISCSI_ITT_MASK 0x1fff
Mike Christie3cf7b232008-05-21 15:54:17 -050071#define ISCSI_TOTAL_CMDS_MAX 4096
72/* this must be a power of two greater than ISCSI_MGMT_CMDS_MAX */
73#define ISCSI_TOTAL_CMDS_MIN 16
Mike Christie7996a772006-04-06 21:13:41 -050074#define ISCSI_AGE_SHIFT 28
Mike Christie262ef632008-12-02 00:32:13 -060075#define ISCSI_AGE_MASK 0xf
Mike Christie7996a772006-04-06 21:13:41 -050076
Mike Christie22236962007-05-30 12:57:24 -050077#define ISCSI_ADDRESS_BUF_LEN 64
78
Olaf Kirchda32dd62007-12-13 12:43:21 -060079enum {
Boaz Harrosh004d6532007-12-13 12:43:23 -060080 /* this is the maximum possible storage for AHSs */
81 ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
82 sizeof(struct iscsi_rlength_ahdr),
Olaf Kirchda32dd62007-12-13 12:43:21 -060083 ISCSI_DIGEST_SIZE = sizeof(__u32),
84};
85
Mike Christie7996a772006-04-06 21:13:41 -050086
Mike Christieb6c395e2006-07-24 15:47:15 -050087enum {
Mike Christie3bbaaad2009-05-13 17:57:46 -050088 ISCSI_TASK_FREE,
Mike Christieb6c395e2006-07-24 15:47:15 -050089 ISCSI_TASK_COMPLETED,
90 ISCSI_TASK_PENDING,
91 ISCSI_TASK_RUNNING,
Mike Christieb3cd5052009-05-13 17:57:49 -050092 ISCSI_TASK_ABRT_TMF, /* aborted due to TMF */
93 ISCSI_TASK_ABRT_SESS_RECOV, /* aborted due to session recovery */
Mike Christief41d4722010-12-31 02:22:21 -060094 ISCSI_TASK_REQUEUE_SCSIQ, /* qcmd requeueing to scsi-ml */
Mike Christieb6c395e2006-07-24 15:47:15 -050095};
96
Mike Christie577577d2008-12-02 00:32:05 -060097struct iscsi_r2t_info {
98 __be32 ttt; /* copied from R2T */
99 __be32 exp_statsn; /* copied from R2T */
100 uint32_t data_length; /* copied from R2T */
101 uint32_t data_offset; /* copied from R2T */
102 int data_count; /* DATA-Out payload progress */
103 int datasn;
104 /* LLDs should set/update these values */
105 int sent; /* R2T sequence progress */
106};
107
Mike Christie9c19a7d2008-05-21 15:54:09 -0500108struct iscsi_task {
Mike Christie7996a772006-04-06 21:13:41 -0500109 /*
Boaz Harrosh004d6532007-12-13 12:43:23 -0600110 * Because LLDs allocate their hdr differently, this is a pointer
111 * and length to that storage. It must be setup at session
112 * creation time.
Mike Christie7996a772006-04-06 21:13:41 -0500113 */
Mike Christie577577d2008-12-02 00:32:05 -0600114 struct iscsi_hdr *hdr;
Boaz Harrosh004d6532007-12-13 12:43:23 -0600115 unsigned short hdr_max;
116 unsigned short hdr_len; /* accumulated size of hdr used */
Mike Christie577577d2008-12-02 00:32:05 -0600117 /* copied values in case we need to send tmfs */
118 itt_t hdr_itt;
119 __be32 cmdsn;
Andy Grover516f43a2011-06-16 15:57:09 -0700120 struct scsi_lun lun;
Mike Christie577577d2008-12-02 00:32:05 -0600121
Mike Christie7996a772006-04-06 21:13:41 -0500122 int itt; /* this ITT */
Mike Christie7996a772006-04-06 21:13:41 -0500123
Mike Christie857ae0b2007-05-30 12:57:15 -0500124 unsigned imm_count; /* imm-data (bytes) */
Mike Christieffd04362006-08-31 18:09:24 -0400125 /* offset in unsolicited stream (bytes); */
Mike Christie577577d2008-12-02 00:32:05 -0600126 struct iscsi_r2t_info unsol_r2t;
Mike Christie3e5c28a2008-05-21 15:54:06 -0500127 char *data; /* mgmt payload */
Mike Christie577577d2008-12-02 00:32:05 -0600128 unsigned data_count;
Mike Christie7996a772006-04-06 21:13:41 -0500129 struct scsi_cmnd *sc; /* associated SCSI cmd*/
Mike Christie7996a772006-04-06 21:13:41 -0500130 struct iscsi_conn *conn; /* used connection */
Mike Christie7996a772006-04-06 21:13:41 -0500131
Mike Christied355e572009-06-15 22:11:08 -0500132 /* data processing tracking */
133 unsigned long last_xfer;
134 unsigned long last_timeout;
135 bool have_checked_conn;
Sagi Grimberg55e51ed2014-03-05 19:43:49 +0200136
137 /* T10 protection information */
138 bool protected;
139
Mike Christieb6c395e2006-07-24 15:47:15 -0500140 /* state set/tested under session->lock */
141 int state;
Mike Christie60ecebf2006-08-31 18:09:25 -0400142 atomic_t refcount;
Mike Christie7996a772006-04-06 21:13:41 -0500143 struct list_head running; /* running cmd list */
144 void *dd_data; /* driver/transport data */
145};
146
Mike Christie577577d2008-12-02 00:32:05 -0600147static inline int iscsi_task_has_unsol_data(struct iscsi_task *task)
148{
149 return task->unsol_r2t.data_length > task->unsol_r2t.sent;
150}
151
Mike Christie9c19a7d2008-05-21 15:54:09 -0500152static inline void* iscsi_next_hdr(struct iscsi_task *task)
Boaz Harrosh004d6532007-12-13 12:43:23 -0600153{
Mike Christie9c19a7d2008-05-21 15:54:09 -0500154 return (void*)task->hdr + task->hdr_len;
Boaz Harrosh004d6532007-12-13 12:43:23 -0600155}
156
Mike Christie6eabafb2008-01-31 13:36:43 -0600157/* Connection's states */
158enum {
159 ISCSI_CONN_INITIAL_STAGE,
160 ISCSI_CONN_STARTED,
161 ISCSI_CONN_STOPPED,
162 ISCSI_CONN_CLEANUP_WAIT,
163};
164
Mike Christie7996a772006-04-06 21:13:41 -0500165struct iscsi_conn {
166 struct iscsi_cls_conn *cls_conn; /* ptr to class connection */
167 void *dd_data; /* iscsi_transport data */
168 struct iscsi_session *session; /* parent session */
169 /*
Mike Christie7996a772006-04-06 21:13:41 -0500170 * conn_stop() flag: stop to recover, stop to terminate
171 */
172 int stop_stage;
Mike Christief6d51802007-12-13 12:43:30 -0600173 struct timer_list transport_timer;
174 unsigned long last_recv;
175 unsigned long last_ping;
176 int ping_timeout;
177 int recv_timeout;
Mike Christie9c19a7d2008-05-21 15:54:09 -0500178 struct iscsi_task *ping_task;
Mike Christie7996a772006-04-06 21:13:41 -0500179
180 /* iSCSI connection-wide sequencing */
181 uint32_t exp_statsn;
Adheer Chandravanshif8525eb2013-07-01 05:54:12 -0400182 uint32_t statsn;
Mike Christie7996a772006-04-06 21:13:41 -0500183
184 /* control data */
185 int id; /* CID */
Mike Christie7996a772006-04-06 21:13:41 -0500186 int c_stage; /* connection state */
Mike Christiec8dc1e52006-07-24 15:47:39 -0500187 /*
188 * Preallocated buffer for pdus that have data but do not
189 * originate from scsi-ml. We never have two pdus using the
190 * buffer at the same time. It is only allocated to
191 * the default max recv size because the pdus we support
192 * should always fit in this buffer
193 */
194 char *data;
Mike Christie9c19a7d2008-05-21 15:54:09 -0500195 struct iscsi_task *login_task; /* mtask used for login/text */
196 struct iscsi_task *task; /* xmit task in progress */
Mike Christie7996a772006-04-06 21:13:41 -0500197
198 /* xmit */
Mike Christie843c0a82007-12-13 12:43:20 -0600199 struct list_head mgmtqueue; /* mgmt (control) xmit queue */
Mike Christie3bbaaad2009-05-13 17:57:46 -0500200 struct list_head cmdqueue; /* data-path cmd queue */
Mike Christie843c0a82007-12-13 12:43:20 -0600201 struct list_head requeue; /* tasks needing another run */
Mike Christie7996a772006-04-06 21:13:41 -0500202 struct work_struct xmitwork; /* per-conn. xmit workqueue */
Mike Christie7996a772006-04-06 21:13:41 -0500203 unsigned long suspend_tx; /* suspend Tx */
204 unsigned long suspend_rx; /* suspend Rx */
205
206 /* abort */
207 wait_queue_head_t ehwait; /* used in eh_abort() */
208 struct iscsi_tm tmhdr;
Mike Christie843c0a82007-12-13 12:43:20 -0600209 struct timer_list tmf_timer;
210 int tmf_state; /* see TMF_INITIAL, etc.*/
Mike Christie7996a772006-04-06 21:13:41 -0500211
212 /* negotiated params */
Mike Christie857ae0b2007-05-30 12:57:15 -0500213 unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
214 unsigned max_xmit_dlength; /* target_max_recv_dsl */
Mike Christie7996a772006-04-06 21:13:41 -0500215 int hdrdgst_en;
216 int datadgst_en;
Mike Christiea54a52c2006-06-28 12:00:23 -0500217 int ifmarker_en;
218 int ofmarker_en;
219 /* values userspace uses to id a conn */
220 int persistent_port;
221 char *persistent_address;
Mike Christie7996a772006-04-06 21:13:41 -0500222
Adheer Chandravanshif8525eb2013-07-01 05:54:12 -0400223 unsigned max_segment_size;
224 unsigned tcp_xmit_wsf;
225 unsigned tcp_recv_wsf;
226 uint16_t keepalive_tmo;
227 uint16_t local_port;
228 uint8_t tcp_timestamp_stat;
229 uint8_t tcp_nagle_disable;
230 uint8_t tcp_wsf_disable;
231 uint8_t tcp_timer_scale;
232 uint8_t tcp_timestamp_en;
233 uint8_t fragment_disable;
234 uint8_t ipv4_tos;
235 uint8_t ipv6_traffic_class;
236 uint8_t ipv6_flow_label;
237 uint8_t is_fw_assigned_ipv6;
Adheer Chandravanshiae56ff42013-11-22 05:28:21 -0500238 char *local_ipaddr;
Adheer Chandravanshif8525eb2013-07-01 05:54:12 -0400239
Mike Christie7996a772006-04-06 21:13:41 -0500240 /* MIB-statistics */
241 uint64_t txdata_octets;
242 uint64_t rxdata_octets;
243 uint32_t scsicmd_pdus_cnt;
244 uint32_t dataout_pdus_cnt;
245 uint32_t scsirsp_pdus_cnt;
246 uint32_t datain_pdus_cnt;
247 uint32_t r2t_pdus_cnt;
248 uint32_t tmfcmd_pdus_cnt;
249 int32_t tmfrsp_pdus_cnt;
250
251 /* custom statistics */
252 uint32_t eh_abort_cnt;
Eli Dorfman87528222008-04-29 13:46:52 -0700253 uint32_t fmr_unalign_cnt;
Mike Christie7996a772006-04-06 21:13:41 -0500254};
255
Olaf Kirch63203772007-12-13 12:43:25 -0600256struct iscsi_pool {
Stefani Seibold45465482009-12-21 14:37:26 -0800257 struct kfifo queue; /* FIFO Queue */
Mike Christie7996a772006-04-06 21:13:41 -0500258 void **pool; /* Pool of elements */
259 int max; /* Max number of elements */
260};
261
Mike Christie6eabafb2008-01-31 13:36:43 -0600262/* Session's states */
263enum {
264 ISCSI_STATE_FREE = 1,
265 ISCSI_STATE_LOGGED_IN,
266 ISCSI_STATE_FAILED,
267 ISCSI_STATE_TERMINATE,
268 ISCSI_STATE_IN_RECOVERY,
269 ISCSI_STATE_RECOVERY_FAILED,
270 ISCSI_STATE_LOGGING_OUT,
271};
272
Mike Christie7996a772006-04-06 21:13:41 -0500273struct iscsi_session {
Mike Christie75613522008-05-21 15:53:59 -0500274 struct iscsi_cls_session *cls_session;
Mike Christie6724add2007-08-15 01:38:30 -0500275 /*
276 * Syncs up the scsi eh thread with the iscsi eh thread when sending
277 * task management functions. This must be taken before the session
278 * and recv lock.
279 */
280 struct mutex eh_mutex;
281
Mike Christie7996a772006-04-06 21:13:41 -0500282 /* iSCSI session-wide sequencing */
283 uint32_t cmdsn;
284 uint32_t exp_cmdsn;
285 uint32_t max_cmdsn;
286
Mike Christiee0726402007-07-26 12:46:48 -0500287 /* This tracks the reqs queued into the initiator */
288 uint32_t queued_cmdsn;
289
Mike Christie7996a772006-04-06 21:13:41 -0500290 /* configuration */
Mike Christief6d51802007-12-13 12:43:30 -0600291 int abort_timeout;
292 int lu_reset_timeout;
Mike Christie3fe5ae82009-11-11 16:34:33 -0600293 int tgt_reset_timeout;
Mike Christie7996a772006-04-06 21:13:41 -0500294 int initial_r2t_en;
Mike Christie1304be52012-01-26 21:13:10 -0600295 unsigned short max_r2t;
Mike Christie7996a772006-04-06 21:13:41 -0500296 int imm_data_en;
Mike Christie857ae0b2007-05-30 12:57:15 -0500297 unsigned first_burst;
298 unsigned max_burst;
Mike Christie7996a772006-04-06 21:13:41 -0500299 int time2wait;
300 int time2retain;
301 int pdu_inorder_en;
302 int dataseq_inorder_en;
303 int erl;
Mike Christie843c0a82007-12-13 12:43:20 -0600304 int fast_abort;
Mike Christiea54a52c2006-06-28 12:00:23 -0500305 int tpgt;
Mike Christieb2c64162007-05-30 12:57:16 -0500306 char *username;
307 char *username_in;
308 char *password;
309 char *password_in;
Mike Christiea54a52c2006-06-28 12:00:23 -0500310 char *targetname;
Vikas Chaudhary3c5c4802012-01-19 03:06:53 -0800311 char *targetalias;
Mike Christie88dfd342008-05-21 15:54:16 -0500312 char *ifacename;
313 char *initiatorname;
Eddie Wai3b9373e2013-06-20 10:21:26 -0700314 char *boot_root;
315 char *boot_nic;
316 char *boot_target;
Adheer Chandravanshif8525eb2013-07-01 05:54:12 -0400317 char *portal_type;
318 char *discovery_parent_type;
319 uint16_t discovery_parent_idx;
320 uint16_t def_taskmgmt_tmo;
321 uint16_t tsid;
322 uint8_t auto_snd_tgt_disable;
323 uint8_t discovery_sess;
324 uint8_t chap_auth_en;
325 uint8_t discovery_logout_en;
326 uint8_t bidi_chap_en;
327 uint8_t discovery_auth_optional;
328 uint8_t isid[ISID_SIZE];
Eddie Wai3b9373e2013-06-20 10:21:26 -0700329
Mike Christie7996a772006-04-06 21:13:41 -0500330 /* control data */
331 struct iscsi_transport *tt;
332 struct Scsi_Host *host;
333 struct iscsi_conn *leadconn; /* leading connection */
Shlomo Pongratz659743b2014-02-07 00:41:38 -0600334 /* Between the forward and the backward locks exists a strict locking
335 * hierarchy. The mutual exclusion zone protected by the forward lock
336 * can enclose the mutual exclusion zone protected by the backward lock
337 * but not vice versa.
338 */
339 spinlock_t frwd_lock; /* protects session state, *
340 * cmdsn, queued_cmdsn *
Mike Christie7996a772006-04-06 21:13:41 -0500341 * session resources: *
Shlomo Pongratz659743b2014-02-07 00:41:38 -0600342 * - cmdpool kfifo_out , *
343 * - mgmtpool, */
344 spinlock_t back_lock; /* protects cmdsn_exp *
345 * cmdsn_max, *
346 * cmdpool kfifo_in */
Mike Christie7996a772006-04-06 21:13:41 -0500347 int state; /* session state */
Mike Christie7996a772006-04-06 21:13:41 -0500348 int age; /* counts session re-opens */
349
Mike Christie3e5c28a2008-05-21 15:54:06 -0500350 int scsi_cmds_max; /* max scsi commands */
Mike Christie7996a772006-04-06 21:13:41 -0500351 int cmds_max; /* size of cmds array */
Mike Christie9c19a7d2008-05-21 15:54:09 -0500352 struct iscsi_task **cmds; /* Original Cmds arr */
Olaf Kirch63203772007-12-13 12:43:25 -0600353 struct iscsi_pool cmdpool; /* PDU's pool */
Jayamohan Kallickalb8b9e1b82009-09-22 08:21:22 +0530354 void *dd_data; /* LLD private data */
Mike Christie7996a772006-04-06 21:13:41 -0500355};
356
Mike Christiee5bd7b52008-09-24 11:46:10 -0500357enum {
358 ISCSI_HOST_SETUP,
359 ISCSI_HOST_REMOVED,
360};
361
Mike Christie75613522008-05-21 15:53:59 -0500362struct iscsi_host {
363 char *initiatorname;
364 /* hw address or netdev iscsi connection is bound to */
365 char *hwaddress;
366 char *netdev;
Mike Christiee5bd7b52008-09-24 11:46:10 -0500367
368 wait_queue_head_t session_removal_wq;
369 /* protects sessions and state */
370 spinlock_t lock;
371 int num_sessions;
372 int state;
Mike Christie32ae7632009-03-05 14:46:03 -0600373
374 struct workqueue_struct *workq;
375 char workq_name[20];
Mike Christie75613522008-05-21 15:53:59 -0500376};
377
Mike Christie7996a772006-04-06 21:13:41 -0500378/*
379 * scsi host template
380 */
Mike Christie7996a772006-04-06 21:13:41 -0500381extern int iscsi_eh_abort(struct scsi_cmnd *sc);
Jayamohan Kallickal309ce152010-02-20 08:02:10 +0530382extern int iscsi_eh_recover_target(struct scsi_cmnd *sc);
383extern int iscsi_eh_session_reset(struct scsi_cmnd *sc);
Mike Christie843c0a82007-12-13 12:43:20 -0600384extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
Mike Christief41d4722010-12-31 02:22:21 -0600385extern int iscsi_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *sc);
Mike Christie7996a772006-04-06 21:13:41 -0500386
Mike Christie0801c242007-05-30 12:57:12 -0500387/*
388 * iSCSI host helpers.
389 */
Mike Christie5d91e202008-05-21 15:54:01 -0500390#define iscsi_host_priv(_shost) \
391 (shost_priv(_shost) + sizeof(struct iscsi_host))
392
Mike Christie0801c242007-05-30 12:57:12 -0500393extern int iscsi_host_set_param(struct Scsi_Host *shost,
394 enum iscsi_host_param param, char *buf,
395 int buflen);
396extern int iscsi_host_get_param(struct Scsi_Host *shost,
397 enum iscsi_host_param param, char *buf);
Mike Christiea4804cd2008-05-21 15:54:00 -0500398extern int iscsi_host_add(struct Scsi_Host *shost, struct device *pdev);
399extern struct Scsi_Host *iscsi_host_alloc(struct scsi_host_template *sht,
Mike Christie4d108352009-03-05 14:46:04 -0600400 int dd_data_size,
Mike Christie32ae7632009-03-05 14:46:03 -0600401 bool xmit_can_sleep);
Mike Christiea4804cd2008-05-21 15:54:00 -0500402extern void iscsi_host_remove(struct Scsi_Host *shost);
403extern void iscsi_host_free(struct Scsi_Host *shost);
Mike Christie6b5d6c42009-04-21 15:32:32 -0500404extern int iscsi_target_alloc(struct scsi_target *starget);
Mike Christie0801c242007-05-30 12:57:12 -0500405
Mike Christie7996a772006-04-06 21:13:41 -0500406/*
407 * session management
408 */
409extern struct iscsi_cls_session *
Mike Christie75613522008-05-21 15:53:59 -0500410iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost,
Jayamohan Kallickalb8b9e1b82009-09-22 08:21:22 +0530411 uint16_t, int, int, uint32_t, unsigned int);
Mike Christie7996a772006-04-06 21:13:41 -0500412extern void iscsi_session_teardown(struct iscsi_cls_session *);
Mike Christie7996a772006-04-06 21:13:41 -0500413extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
Mike Christiea54a52c2006-06-28 12:00:23 -0500414extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
415 enum iscsi_param param, char *buf, int buflen);
416extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
417 enum iscsi_param param, char *buf);
Mike Christie7996a772006-04-06 21:13:41 -0500418
Mike Christie322d7392008-01-31 13:36:52 -0600419#define iscsi_session_printk(prefix, _sess, fmt, a...) \
Mike Christie75613522008-05-21 15:53:59 -0500420 iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a)
Mike Christie322d7392008-01-31 13:36:52 -0600421
Mike Christie7996a772006-04-06 21:13:41 -0500422/*
423 * connection management
424 */
425extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
Mike Christie5d91e202008-05-21 15:54:01 -0500426 int, uint32_t);
Mike Christie7996a772006-04-06 21:13:41 -0500427extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
428extern int iscsi_conn_start(struct iscsi_cls_conn *);
429extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
430extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
431 int);
432extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
Mike Christie40a06e72009-03-05 14:46:05 -0600433extern void iscsi_session_failure(struct iscsi_session *session,
Mike Christiee5bd7b52008-09-24 11:46:10 -0500434 enum iscsi_err err);
Mike Christiea54a52c2006-06-28 12:00:23 -0500435extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
436 enum iscsi_param param, char *buf);
Mike Christie00f37082011-02-16 15:04:35 -0600437extern int iscsi_conn_get_addr_param(struct sockaddr_storage *addr,
438 enum iscsi_param param, char *buf);
Mike Christie5af3e912008-05-21 15:54:02 -0500439extern void iscsi_suspend_tx(struct iscsi_conn *conn);
Mike Christie661134a2009-09-05 07:35:33 +0530440extern void iscsi_suspend_queue(struct iscsi_conn *conn);
Mike Christie32ae7632009-03-05 14:46:03 -0600441extern void iscsi_conn_queue_work(struct iscsi_conn *conn);
Mike Christie7996a772006-04-06 21:13:41 -0500442
Mike Christie322d7392008-01-31 13:36:52 -0600443#define iscsi_conn_printk(prefix, _c, fmt, a...) \
Mike Christie5af3e912008-05-21 15:54:02 -0500444 iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \
445 fmt, ##a)
Mike Christie322d7392008-01-31 13:36:52 -0600446
Mike Christie7996a772006-04-06 21:13:41 -0500447/*
448 * pdu and task processing
449 */
Mike Christie77a23c22007-05-30 12:57:18 -0500450extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
Mike Christie577577d2008-12-02 00:32:05 -0600451extern void iscsi_prep_data_out_pdu(struct iscsi_task *task,
452 struct iscsi_r2t_info *r2t,
453 struct iscsi_data *hdr);
Mike Christie7996a772006-04-06 21:13:41 -0500454extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
455 char *, uint32_t);
456extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
457 char *, int);
Mike Christie913e5bf2008-05-21 15:54:18 -0500458extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
459 char *, int);
Mike Christie0af967f2008-05-21 15:54:04 -0500460extern int iscsi_verify_itt(struct iscsi_conn *, itt_t);
Mike Christie9c19a7d2008-05-21 15:54:09 -0500461extern struct iscsi_task *iscsi_itt_to_ctask(struct iscsi_conn *, itt_t);
Mike Christie8f9256c2009-05-13 17:57:41 -0500462extern struct iscsi_task *iscsi_itt_to_task(struct iscsi_conn *, itt_t);
Mike Christie9c19a7d2008-05-21 15:54:09 -0500463extern void iscsi_requeue_task(struct iscsi_task *task);
464extern void iscsi_put_task(struct iscsi_task *task);
Eddie Wai8eea2f52010-11-23 15:29:21 -0800465extern void __iscsi_put_task(struct iscsi_task *task);
Mike Christie913e5bf2008-05-21 15:54:18 -0500466extern void __iscsi_get_task(struct iscsi_task *task);
Mike Christie4c0ba5d2009-09-05 07:34:23 +0530467extern void iscsi_complete_scsi_task(struct iscsi_task *task,
468 uint32_t exp_cmdsn, uint32_t max_cmdsn);
Mike Christie7996a772006-04-06 21:13:41 -0500469
470/*
471 * generic helpers
472 */
Olaf Kirch63203772007-12-13 12:43:25 -0600473extern void iscsi_pool_free(struct iscsi_pool *);
474extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int);
Adheer Chandravanshiadaf6992013-03-22 07:41:30 -0400475extern int iscsi_switch_str_param(char **, char *);
Mike Christie7996a772006-04-06 21:13:41 -0500476
Boaz Harrosh004d6532007-12-13 12:43:23 -0600477/*
478 * inline functions to deal with padding.
479 */
480static inline unsigned int
481iscsi_padded(unsigned int len)
482{
483 return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
484}
485
486static inline unsigned int
487iscsi_padding(unsigned int len)
488{
489 len &= (ISCSI_PAD_LEN - 1);
490 if (len)
491 len = ISCSI_PAD_LEN - len;
492 return len;
493}
494
Mike Christie7996a772006-04-06 21:13:41 -0500495#endif