ISCSI.cpp@ 34906

Last change on this file since 34906 was 33567, checked in by vboxsync, 14 years ago
VD: Move the generic virtual disk framework + backends to src/VBox/Storage and rename the files to get rid of the HDD part because it supports floppy and DVD images too
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 192.0 KB

Line
1	/* $Id: ISCSI.cpp 33567 2010-10-28 15:37:21Z vboxsync $ */
2	/** @file
3	* iSCSI initiator driver, VD backend.
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/*******************************************************************************
20	* Header Files *
21	*******************************************************************************/
22	#define LOG_GROUP LOG_GROUP_VD_ISCSI
23	#include <VBox/vd-plugin.h>
24	#include <VBox/err.h>
25
26	#include <VBox/log.h>
27	#include <iprt/alloc.h>
28	#include <iprt/assert.h>
29	#include <iprt/uuid.h>
30	#include <iprt/string.h>
31	#include <iprt/asm.h>
32	#include <iprt/thread.h>
33	#include <iprt/semaphore.h>
34	#include <iprt/md5.h>
35	#include <iprt/tcp.h>
36	#include <iprt/time.h>
37	#include <VBox/scsi.h>
38
39
40	/*******************************************************************************
41	* Defined Constants And Macros *
42	*******************************************************************************/
43
44	/** Default port number to use for iSCSI. */
45	#define ISCSI_DEFAULT_PORT 3260
46
47
48	/** Converts a number in the range of 0 - 15 into the corresponding hex char. */
49	#define NUM_2_HEX(b) ('0' + (b) + (((b) > 9) ? 39 : 0))
50	/** Converts a hex char into the corresponding number in the range 0-15. */
51	#define HEX_2_NUM(c) (((c) <= '9') ? ((c) - '0') : (((c - 'A' + 10) & 0xf)))
52	/* Converts a base64 char into the corresponding number in the range 0-63. */
53	#define B64_2_NUM(c) ((c >= 'A' && c <= 'Z') ? (c - 'A') : (c >= 'a' && c <= 'z') ? (c - 'a' + 26) : (c >= '0' && c <= '9') ? (c - '0' + 52) : (c == '+') ? 62 : (c == '/') ? 63 : -1)
54
55
56	/** Minimum CHAP_MD5 challenge length in bytes. */
57	#define CHAP_MD5_CHALLENGE_MIN 16
58	/** Maximum CHAP_MD5 challenge length in bytes. */
59	#define CHAP_MD5_CHALLENGE_MAX 24
60
61
62	/**
63	* SCSI peripheral device type. */
64	typedef enum SCSIDEVTYPE
65	{
66	/** direct-access device. */
67	SCSI_DEVTYPE_DISK = 0,
68	/** sequential-access device. */
69	SCSI_DEVTYPE_TAPE,
70	/** printer device. */
71	SCSI_DEVTYPE_PRINTER,
72	/** processor device. */
73	SCSI_DEVTYPE_PROCESSOR,
74	/** write-once device. */
75	SCSI_DEVTYPE_WORM,
76	/** CD/DVD device. */
77	SCSI_DEVTYPE_CDROM,
78	/** scanner device. */
79	SCSI_DEVTYPE_SCANNER,
80	/** optical memory device. */
81	SCSI_DEVTYPE_OPTICAL,
82	/** medium changer. */
83	SCSI_DEVTYPE_CHANGER,
84	/** communications device. */
85	SCSI_DEVTYPE_COMMUNICATION,
86	/** storage array controller device. */
87	SCSI_DEVTYPE_RAIDCTL = 0x0c,
88	/** enclosure services device. */
89	SCSI_DEVTYPE_ENCLOSURE,
90	/** simplified direct-access device. */
91	SCSI_DEVTYPE_SIMPLEDISK,
92	/** optical card reader/writer device. */
93	SCSI_DEVTYPE_OCRW,
94	/** bridge controller device. */
95	SCSI_DEVTYPE_BRIDGE,
96	/** object-based storage device. */
97	SCSI_DEVTYPE_OSD
98	} SCSIDEVTYPE;
99
100	/** Mask for extracting the SCSI device type out of the first byte of the INQUIRY response. */
101	#define SCSI_DEVTYPE_MASK 0x1f
102
103	/** Mask to extract the CmdQue bit out of the seventh byte of the INQUIRY response. */
104	#define SCSI_INQUIRY_CMDQUE_MASK 0x02
105
106	/** Maximum PDU payload size we can handle in one piece. Greater or equal than
107	* s_iscsiConfigDefaultWriteSplit. */
108	#define ISCSI_DATA_LENGTH_MAX _256K
109
110	/** Maximum PDU size we can handle in one piece. */
111	#define ISCSI_RECV_PDU_BUFFER_SIZE (ISCSI_DATA_LENGTH_MAX + ISCSI_BHS_SIZE)
112
113
114	/** Version of the iSCSI standard which this initiator driver can handle. */
115	#define ISCSI_MY_VERSION 0
116
117
118	/** Length of ISCSI basic header segment. */
119	#define ISCSI_BHS_SIZE 48
120
121
122	/** Reserved task tag value. */
123	#define ISCSI_TASK_TAG_RSVD 0xffffffff
124
125
126	/**
127	* iSCSI opcodes. */
128	typedef enum ISCSIOPCODE
129	{
130	/** NOP-Out. */
131	ISCSIOP_NOP_OUT = 0x00000000,
132	/** SCSI command. */
133	ISCSIOP_SCSI_CMD = 0x01000000,
134	/** SCSI task management request. */
135	ISCSIOP_SCSI_TASKMGMT_REQ = 0x02000000,
136	/** Login request. */
137	ISCSIOP_LOGIN_REQ = 0x03000000,
138	/** Text request. */
139	ISCSIOP_TEXT_REQ = 0x04000000,
140	/** SCSI Data-Out. */
141	ISCSIOP_SCSI_DATA_OUT = 0x05000000,
142	/** Logout request. */
143	ISCSIOP_LOGOUT_REQ = 0x06000000,
144	/** SNACK request. */
145	ISCSIOP_SNACK_REQ = 0x10000000,
146
147	/** NOP-In. */
148	ISCSIOP_NOP_IN = 0x20000000,
149	/** SCSI response. */
150	ISCSIOP_SCSI_RES = 0x21000000,
151	/** SCSI Task Management response. */
152	ISCSIOP_SCSI_TASKMGMT_RES = 0x22000000,
153	/** Login response. */
154	ISCSIOP_LOGIN_RES = 0x23000000,
155	/** Text response. */
156	ISCSIOP_TEXT_RES = 0x24000000,
157	/** SCSI Data-In. */
158	ISCSIOP_SCSI_DATA_IN = 0x25000000,
159	/** Logout response. */
160	ISCSIOP_LOGOUT_RES = 0x26000000,
161	/** Ready To Transfer (R2T). */
162	ISCSIOP_R2T = 0x31000000,
163	/** Asynchronous message. */
164	ISCSIOP_ASYN_MSG = 0x32000000,
165	/** Reject. */
166	ISCSIOP_REJECT = 0x3f000000
167	} ISCSIOPCODE;
168
169	/** Mask for extracting the iSCSI opcode out of the first header word. */
170	#define ISCSIOP_MASK 0x3f000000
171
172
173	/** ISCSI BHS word 0: Request should be processed immediately. */
174	#define ISCSI_IMMEDIATE_DELIVERY_BIT 0x40000000
175
176	/** ISCSI BHS word 0: This is the final PDU for this request/response. */
177	#define ISCSI_FINAL_BIT 0x00800000
178	/** ISCSI BHS word 0: Mask for extracting the CSG. */
179	#define ISCSI_CSG_MASK 0x000c0000
180	/** ISCSI BHS word 0: Shift offset for extracting the CSG. */
181	#define ISCSI_CSG_SHIFT 18
182	/** ISCSI BHS word 0: Mask for extracting the NSG. */
183	#define ISCSI_NSG_MASK 0x00030000
184	/** ISCSI BHS word 0: Shift offset for extracting the NSG. */
185	#define ISCSI_NSG_SHIFT 16
186
187	/** ISCSI BHS word 0: task attribute untagged */
188	#define ISCSI_TASK_ATTR_UNTAGGED 0x00000000
189	/** ISCSI BHS word 0: task attribute simple */
190	#define ISCSI_TASK_ATTR_SIMPLE 0x00010000
191	/** ISCSI BHS word 0: task attribute ordered */
192	#define ISCSI_TASK_ATTR_ORDERED 0x00020000
193	/** ISCSI BHS word 0: task attribute head of queue */
194	#define ISCSI_TASK_ATTR_HOQ 0x00030000
195	/** ISCSI BHS word 0: task attribute ACA */
196	#define ISCSI_TASK_ATTR_ACA 0x00040000
197
198	/** ISCSI BHS word 0: transit to next login phase. */
199	#define ISCSI_TRANSIT_BIT 0x00800000
200	/** ISCSI BHS word 0: continue with login negotiation. */
201	#define ISCSI_CONTINUE_BIT 0x00400000
202
203	/** ISCSI BHS word 0: residual underflow. */
204	#define ISCSI_RESIDUAL_UNFL_BIT 0x00020000
205	/** ISCSI BHS word 0: residual overflow. */
206	#define ISCSI_RESIDUAL_OVFL_BIT 0x00040000
207	/** ISCSI BHS word 0: Bidirectional read residual underflow. */
208	#define ISCSI_BI_READ_RESIDUAL_UNFL_BIT 0x00080000
209	/** ISCSI BHS word 0: Bidirectional read residual overflow. */
210	#define ISCSI_BI_READ_RESIDUAL_OVFL_BIT 0x00100000
211
212	/** ISCSI BHS word 0: SCSI response mask. */
213	#define ISCSI_SCSI_RESPONSE_MASK 0x0000ff00
214	/** ISCSI BHS word 0: SCSI status mask. */
215	#define ISCSI_SCSI_STATUS_MASK 0x000000ff
216
217	/** ISCSI BHS word 0: response includes status. */
218	#define ISCSI_STATUS_BIT 0x00010000
219
220	/** Maximum number of scatter/gather segments needed to send a PDU. */
221	#define ISCSI_SG_SEGMENTS_MAX 4
222
223	/** Number of entries in the command table. */
224	#define ISCSI_CMD_WAITING_ENTRIES 32
225
226	/**
227	* iSCSI login status class. */
228	typedef enum ISCSILOGINSTATUSCLASS
229	{
230	/** Success. */
231	ISCSI_LOGIN_STATUS_CLASS_SUCCESS = 0,
232	/** Redirection. */
233	ISCSI_LOGIN_STATUS_CLASS_REDIRECTION,
234	/** Initiator error. */
235	ISCSI_LOGIN_STATUS_CLASS_INITIATOR_ERROR,
236	/** Target error. */
237	ISCSI_LOGIN_STATUS_CLASS_TARGET_ERROR
238	} ISCSILOGINSTATUSCLASS;
239
240
241	/**
242	* iSCSI connection state. */
243	typedef enum ISCSISTATE
244	{
245	/** Not having a connection/session at all. */
246	ISCSISTATE_FREE,
247	/** Currently trying to login. */
248	ISCSISTATE_IN_LOGIN,
249	/** Normal operation, corresponds roughly to the Full Feature Phase. */
250	ISCSISTATE_NORMAL,
251	/** Currently trying to logout. */
252	ISCSISTATE_IN_LOGOUT
253	} ISCSISTATE;
254
255	/**
256	* iSCSI PDU send flags (and maybe more in the future). */
257	typedef enum ISCSIPDUFLAGS
258	{
259	/** No special flags */
260	ISCSIPDU_DEFAULT = 0,
261	/** Do not attempt to re-attach to the target if the connection is lost */
262	ISCSIPDU_NO_REATTACH = RT_BIT(1)
263	} ISCSIPDUFLAGS;
264
265
266	/*******************************************************************************
267	* Structures and Typedefs *
268	*******************************************************************************/
269
270	/**
271	* iSCSI login negotiation parameter
272	*/
273	typedef struct ISCSIPARAMETER
274	{
275	/** Name of the parameter. */
276	const char *pszParamName;
277	/** Value of the parameter. */
278	const char *pszParamValue;
279	/** Length of the binary parameter. 0=zero-terminated string. */
280	size_t cbParamValue;
281	} ISCSIPARAMETER;
282
283
284	/**
285	* iSCSI Response PDU buffer (scatter).
286	*/
287	typedef struct ISCSIRES
288	{
289	/** Length of PDU segment. */
290	size_t cbSeg;
291	/** Pointer to PDU segment. */
292	void *pvSeg;
293	} ISCSIRES;
294	/** Pointer to an iSCSI Response PDU buffer. */
295	typedef ISCSIRES *PISCSIRES;
296	/** Pointer to a const iSCSI Response PDU buffer. */
297	typedef ISCSIRES const *PCISCSIRES;
298
299
300	/**
301	* iSCSI Request PDU buffer (gather).
302	*/
303	typedef struct ISCSIREQ
304	{
305	/** Length of PDU segment in bytes. */
306	size_t cbSeg;
307	/** Pointer to PDU segment. */
308	const void *pcvSeg;
309	} ISCSIREQ;
310	/** Pointer to an iSCSI Request PDU buffer. */
311	typedef ISCSIREQ *PISCSIREQ;
312	/** Pointer to a const iSCSI Request PDU buffer. */
313	typedef ISCSIREQ const *PCISCSIREQ;
314
315
316	/**
317	* SCSI transfer directions.
318	*/
319	typedef enum SCSIXFER
320	{
321	SCSIXFER_NONE = 0,
322	SCSIXFER_TO_TARGET,
323	SCSIXFER_FROM_TARGET,
324	SCSIXFER_TO_FROM_TARGET
325	} SCSIXFER, *PSCSIXFER;
326
327	/** Forward declaration. */
328	typedef struct ISCSIIMAGE *PISCSIIMAGE;
329
330	/**
331	* SCSI request structure.
332	*/
333	typedef struct SCSIREQ
334	{
335	/** Transfer direction. */
336	SCSIXFER enmXfer;
337	/** Length of command block. */
338	size_t cbCDB;
339	/** Length of Initiator2Target data buffer. */
340	size_t cbI2TData;
341	/** Length of Target2Initiator data buffer. */
342	size_t cbT2IData;
343	/** Length of sense buffer
344	* This contains the number of sense bytes received upon completion. */
345	size_t cbSense;
346	/** Completion status of the command. */
347	uint8_t status;
348	/** Pointer to command block. */
349	void *pvCDB;
350	/** Pointer to sense buffer. */
351	void *pvSense;
352	/** Pointer to the Initiator2Target S/G list. */
353	PRTSGSEG paI2TSegs;
354	/** Number of entries in the I2T S/G list. */
355	unsigned cI2TSegs;
356	/** Pointer to the Target2Initiator S/G list. */
357	PRTSGSEG paT2ISegs;
358	/** Number of entries in the T2I S/G list. */
359	unsigned cT2ISegs;
360	/** S/G buffer for the target to initiator bits. */
361	RTSGBUF SgBufT2I;
362	} SCSIREQ, *PSCSIREQ;
363
364	/**
365	* Async request structure holding all necessary data for
366	* request processing.
367	*/
368	typedef struct SCSIREQASYNC
369	{
370	/** I/O context associated with this request. */
371	PVDIOCTX pIoCtx;
372	/** Pointer to the SCSI request structure. */
373	PSCSIREQ pScsiReq;
374	/** The CDB. */
375	uint8_t abCDB[16];
376	/** The sense buffer. */
377	uint8_t abSense[96];
378	/** Status code to return if we got sense data. */
379	int rcSense;
380	/** Number of retries if the command completes with sense
381	* data before we return with an error.
382	*/
383	unsigned cSenseRetries;
384	/** The number of entries in the I2T S/G list. */
385	unsigned cI2TSegs;
386	/** The number of entries in the T2I S/G list. */
387	unsigned cT2ISegs;
388	/** The S/G list - variable in size.
389	* This array holds both the I2T and T2I segments.
390	* The I2T segments are first and the T2I are second.
391	*/
392	RTSGSEG aSegs[1];
393	} SCSIREQASYNC, *PSCSIREQASYNC;
394
395	typedef enum ISCSICMDTYPE
396	{
397	/** Process a SCSI request. */
398	ISCSICMDTYPE_REQ = 0,
399	/** Call a function in the I/O thread. */
400	ISCSICMDTYPE_EXEC,
401	/** Usual 32bit hack. */
402	ISCSICMDTYPE_32BIT_HACK = 0x7fffffff
403	} ISCSICMDTYPE;
404
405
406	/** The command completion function. */
407	typedef DECLCALLBACK(void) FNISCSICMDCOMPLETED(PISCSIIMAGE pImage, int rcReq, void *pvUser);
408	/** Pointer to a command completion function. */
409	typedef FNISCSICMDCOMPLETED *PFNISCSICMDCOMPLETED;
410
411	/** The command execution function. */
412	typedef DECLCALLBACK(int) FNISCSIEXEC(void *pvUser);
413	/** Pointer to a command execution function. */
414	typedef FNISCSIEXEC *PFNISCSIEXEC;
415
416	/**
417	* Structure used to complete a synchronous request.
418	*/
419	typedef struct ISCSICMDSYNC
420	{
421	/** Event semaphore to wakeup the waiting thread. */
422	RTSEMEVENT EventSem;
423	/** Status code of the command. */
424	int rcCmd;
425	} ISCSICMDSYNC, *PISCSICMDSYNC;
426
427	/**
428	* iSCSI command.
429	* Used to forward requests to the I/O thread
430	* if existing.
431	*/
432	typedef struct ISCSICMD
433	{
434	/** Next one in the list. */
435	struct ISCSICMD *pNext;
436	/** Assigned ITT. */
437	uint32_t Itt;
438	/** Completion callback. */
439	PFNISCSICMDCOMPLETED pfnComplete;
440	/** Opaque user data. */
441	void *pvUser;
442	/** Command to execute. */
443	ISCSICMDTYPE enmCmdType;
444	/** Command type dependent data. */
445	union
446	{
447	/** Process a SCSI request. */
448	struct
449	{
450	/** The SCSI request to process. */
451	PSCSIREQ pScsiReq;
452	} ScsiReq;
453	/** Call a function in the I/O thread. */
454	struct
455	{
456	/** The method to execute. */
457	PFNISCSIEXEC pfnExec;
458	/** User data. */
459	void *pvUser;
460	} Exec;
461	} CmdType;
462	} ISCSICMD, *PISCSICMD;
463
464	/**
465	* Send iSCSI PDU.
466	* Contains all necessary data to send a PDU.
467	*/
468	typedef struct ISCSIPDUTX
469	{
470	/** Pointer to the next PDu to send. */
471	struct ISCSIPDUTX *pNext;
472	/** The BHS. */
473	uint32_t aBHS[12];
474	/** Assigned CmdSN for this PDU. */
475	uint32_t CmdSN;
476	/** The S/G buffer used for sending. */
477	RTSGBUF SgBuf;
478	/** Number of bytes to send until the PDU completed. */
479	size_t cbSgLeft;
480	/** The iSCSI command this PDU belongs to. */
481	PISCSICMD pIScsiCmd;
482	/** Number of segments in the request segments array. */
483	unsigned cISCSIReq;
484	/** The request segments - variable in size. */
485	RTSGSEG aISCSIReq[1];
486	} ISCSIPDUTX, *PISCSIPDUTX;
487
488	/**
489	* Block driver instance data.
490	*/
491	typedef struct ISCSIIMAGE
492	{
493	/** Pointer to the filename (location). Not really used. */
494	const char *pszFilename;
495	/** Pointer to the initiator name. */
496	char *pszInitiatorName;
497	/** Pointer to the target name. */
498	char *pszTargetName;
499	/** Pointer to the target address. */
500	char *pszTargetAddress;
501	/** Pointer to the user name for authenticating the Initiator. */
502	char *pszInitiatorUsername;
503	/** Pointer to the secret for authenticating the Initiator. */
504	uint8_t *pbInitiatorSecret;
505	/** Length of the secret for authenticating the Initiator. */
506	size_t cbInitiatorSecret;
507	/** Pointer to the user name for authenticating the Target. */
508	char *pszTargetUsername;
509	/** Pointer to the secret for authenticating the Initiator. */
510	uint8_t *pbTargetSecret;
511	/** Length of the secret for authenticating the Initiator. */
512	size_t cbTargetSecret;
513	/** Limit for iSCSI writes, essentially limiting the amount of data
514	* written in a single write. This is negotiated with the target, so
515	* the actual size might be smaller. */
516	uint32_t cbWriteSplit;
517	/** Initiator session identifier. */
518	uint64_t ISID;
519	/** SCSI Logical Unit Number. */
520	uint64_t LUN;
521	/** Pointer to the per-disk VD interface list. */
522	PVDINTERFACE pVDIfsDisk;
523	/** Error interface. */
524	PVDINTERFACE pInterfaceError;
525	/** Error interface callback table. */
526	PVDINTERFACEERROR pInterfaceErrorCallbacks;
527	/** Pointer to the per-image VD interface list. */
528	PVDINTERFACE pVDIfsImage;
529	/** Config interface. */
530	PVDINTERFACE pInterfaceConfig;
531	/** Config interface callback table. */
532	PVDINTERFACECONFIG pInterfaceConfigCallbacks;
533	/** I/O interface. */
534	PVDINTERFACE pInterfaceIo;
535	/** I/O interface callback table. */
536	PVDINTERFACEIOINT pInterfaceIoCallbacks;
537	/** TCP network stack interface. */
538	PVDINTERFACE pInterfaceNet;
539	/** TCP network stack interface callback table. */
540	PVDINTERFACETCPNET pInterfaceNetCallbacks;
541	/** Image open flags. */
542	unsigned uOpenFlags;
543	/** Number of re-login retries when a connection fails. */
544	uint32_t cISCSIRetries;
545	/** Sector size on volume. */
546	uint32_t cbSector;
547	/** Size of volume in sectors. */
548	uint64_t cVolume;
549	/** Total volume size in bytes. Easier than multiplying the above values all the time. */
550	uint64_t cbSize;
551
552	/** Negotiated maximum data length when sending to target. */
553	uint32_t cbSendDataLength;
554	/** Negotiated maximum data length when receiving from target. */
555	uint32_t cbRecvDataLength;
556
557	/** Current state of the connection/session. */
558	ISCSISTATE state;
559	/** Flag whether the first Login Response PDU has been seen. */
560	bool FirstRecvPDU;
561	/** Initiator Task Tag of the last iSCSI request PDU. */
562	uint32_t ITT;
563	/** Sequence number of the last command. */
564	uint32_t CmdSN;
565	/** Sequence number of the next command expected by the target. */
566	uint32_t ExpCmdSN;
567	/** Maximum sequence number accepted by the target (determines size of window). */
568	uint32_t MaxCmdSN;
569	/** Expected sequence number of next status. */
570	uint32_t ExpStatSN;
571	/** Currently active request. */
572	PISCSIREQ paCurrReq;
573	/** Segment number of currently active request. */
574	uint32_t cnCurrReq;
575	/** Pointer to receive PDU buffer. (Freed by RT) */
576	void *pvRecvPDUBuf;
577	/** Length of receive PDU buffer. */
578	size_t cbRecvPDUBuf;
579	/** Mutex protecting against concurrent use from several threads. */
580	RTSEMMUTEX Mutex;
581
582	/** Pointer to the target hostname. */
583	char *pszHostname;
584	/** Pointer to the target hostname. */
585	uint32_t uPort;
586	/** Socket handle of the TCP connection. */
587	VDSOCKET Socket;
588	/** Timeout for read operations on the TCP connection (in milliseconds). */
589	uint32_t uReadTimeout;
590	/** Flag whether to automatically generate the initiator name. */
591	bool fAutomaticInitiatorName;
592	/** Flag whether to use the host IP stack or DevINIP. */
593	bool fHostIP;
594
595	/** Head of request queue */
596	PISCSICMD pScsiReqQueue;
597	/** Mutex protecting the request queue from concurrent access. */
598	RTSEMMUTEX MutexReqQueue;
599	/** I/O thread. */
600	RTTHREAD hThreadIo;
601	/** Flag whether the thread should be still running. */
602	volatile bool fRunning;
603	/* Flag whether the target supports command queuing. */
604	bool fCmdQueuingSupported;
605	/** Flag whether extended select is supported. */
606	bool fExtendedSelectSupported;
607	/** Padding used for aligning the PDUs. */
608	uint8_t aPadding[4];
609	/** Socket events to poll for. */
610	uint32_t fPollEvents;
611	/** Number of bytes to read to complete the current PDU. */
612	size_t cbRecvPDUResidual;
613	/** Current position in the PDU buffer. */
614	uint8_t *pbRecvPDUBufCur;
615	/** Flag whether we are currently reading the BHS. */
616	bool fRecvPDUBHS;
617	/** List of PDUs waiting to get transmitted. */
618	PISCSIPDUTX pIScsiPDUTxHead;
619	/** Tail of PDUs waiting to get transmitted. */
620	PISCSIPDUTX pIScsiPDUTxTail;
621	/** PDU we are currently transmitting. */
622	PISCSIPDUTX pIScsiPDUTxCur;
623	/** Number of commands waiting for an answer from the target.
624	* Used for timeout handling for poll.
625	*/
626	unsigned cCmdsWaiting;
627	/** Table of commands waiting for a response from the target. */
628	PISCSICMD aCmdsWaiting[ISCSI_CMD_WAITING_ENTRIES];
629	} ISCSIIMAGE;
630
631
632	/*******************************************************************************
633	* Static Variables *
634	*******************************************************************************/
635
636	/** Default initiator basename. */
637	static const char *s_iscsiDefaultInitiatorBasename = "iqn.2009-08.com.sun.virtualbox.initiator";
638
639	/** Default LUN. */
640	static const char *s_iscsiConfigDefaultLUN = "0";
641
642	/** Default timeout, 10 seconds. */
643	static const char *s_iscsiConfigDefaultTimeout = "10000";
644
645	/** Default write split value, less or equal to ISCSI_DATA_LENGTH_MAX. */
646	static const char *s_iscsiConfigDefaultWriteSplit = "262144";
647
648	/** Default host IP stack. */
649	static const char *s_iscsiConfigDefaultHostIPStack = "1";
650
651	/** Description of all accepted config parameters. */
652	static const VDCONFIGINFO s_iscsiConfigInfo[] =
653	{
654	{ "TargetName", NULL, VDCFGVALUETYPE_STRING, VD_CFGKEY_MANDATORY },
655	/* LUN is defined of string type to handle the "enc" prefix. */
656	{ "LUN", s_iscsiConfigDefaultLUN, VDCFGVALUETYPE_STRING, VD_CFGKEY_MANDATORY },
657	{ "TargetAddress", NULL, VDCFGVALUETYPE_STRING, VD_CFGKEY_MANDATORY },
658	{ "InitiatorName", NULL, VDCFGVALUETYPE_STRING, 0 },
659	{ "InitiatorUsername", NULL, VDCFGVALUETYPE_STRING, 0 },
660	{ "InitiatorSecret", NULL, VDCFGVALUETYPE_BYTES, 0 },
661	{ "TargetUsername", NULL, VDCFGVALUETYPE_STRING, VD_CFGKEY_EXPERT },
662	{ "TargetSecret", NULL, VDCFGVALUETYPE_BYTES, VD_CFGKEY_EXPERT },
663	{ "WriteSplit", s_iscsiConfigDefaultWriteSplit, VDCFGVALUETYPE_INTEGER, VD_CFGKEY_EXPERT },
664	{ "Timeout", s_iscsiConfigDefaultTimeout, VDCFGVALUETYPE_INTEGER, VD_CFGKEY_EXPERT },
665	{ "HostIPStack", s_iscsiConfigDefaultHostIPStack, VDCFGVALUETYPE_INTEGER, VD_CFGKEY_EXPERT },
666	{ NULL, NULL, VDCFGVALUETYPE_INTEGER, 0 }
667	};
668
669	/*******************************************************************************
670	* Internal Functions *
671	*******************************************************************************/
672
673	/* iSCSI low-level functions (only to be used from the iSCSI high-level functions). */
674	static uint32_t iscsiNewITT(PISCSIIMAGE pImage);
675	static int iscsiSendPDU(PISCSIIMAGE pImage, PISCSIREQ paReq, uint32_t cnReq, uint32_t uFlags);
676	static int iscsiRecvPDU(PISCSIIMAGE pImage, uint32_t itt, PISCSIRES paRes, uint32_t cnRes);
677	static int iscsiRecvPDUAsync(PISCSIIMAGE pImage);
678	static int iscsiSendPDUAsync(PISCSIIMAGE pImage);
679	static int iscsiValidatePDU(PISCSIRES paRes, uint32_t cnRes);
680	static int iscsiRecvPDUProcess(PISCSIIMAGE pImage, PISCSIRES paRes, uint32_t cnRes);
681	static int iscsiPDUTxPrepare(PISCSIIMAGE pImage, PISCSICMD pIScsiCmd);
682	static int iscsiRecvPDUUpdateRequest(PISCSIIMAGE pImage, PISCSIRES paRes, uint32_t cnRes);
683	static void iscsiCmdComplete(PISCSIIMAGE pImage, PISCSICMD pIScsiCmd, int rcCmd);
684	static int iscsiTextAddKeyValue(uint8_t pbBuf, size_t cbBuf, size_t pcbBufCurr, const char pcszKey, const char pcszValue, size_t cbValue);
685	static int iscsiTextGetKeyValue(const uint8_t pbBuf, size_t cbBuf, const char pcszKey, const char **ppcszValue);
686	static int iscsiStrToBinary(const char pcszValue, uint8_t pbValue, size_t *pcbValue);
687	static int iscsiUpdateParameters(PISCSIIMAGE pImage, const uint8_t *pbBuf, size_t cbBuf);
688
689	/* Serial number arithmetic comparison. */
690	static bool serial_number_less(uint32_t sn1, uint32_t sn2);
691	static bool serial_number_greater(uint32_t sn1, uint32_t sn2);
692
693	/* CHAP-MD5 functions. */
694	#ifdef IMPLEMENT_TARGET_AUTH
695	static void chap_md5_generate_challenge(uint8_t pbChallenge, size_t pcbChallenge);
696	#endif
697	static void chap_md5_compute_response(uint8_t pbResponse, uint8_t id, const uint8_t pbChallenge, size_t cbChallenge,
698	const uint8_t *pbSecret, size_t cbSecret);
699
700
701	/**
702	* Internal: signal an error to the frontend.
703	*/
704	DECLINLINE(int) iscsiError(PISCSIIMAGE pImage, int rc, RT_SRC_POS_DECL,
705	const char *pszFormat, ...)
706	{
707	va_list va;
708	va_start(va, pszFormat);
709	if (pImage->pInterfaceError)
710	pImage->pInterfaceErrorCallbacks->pfnError(pImage->pInterfaceError->pvUser, rc, RT_SRC_POS_ARGS,
711	pszFormat, va);
712	va_end(va);
713
714	#ifdef LOG_ENABLED
715	va_start(va, pszFormat);
716	Log(("iscsiError(%d/%s): %N\n", iLine, pszFunction, pszFormat, &va));
717	va_end(va);
718	#endif
719	return rc;
720	}
721
722	/**
723	* Internal: signal an informational message to the frontend.
724	*/
725	DECLINLINE(int) iscsiMessage(PISCSIIMAGE pImage, const char *pszFormat, ...)
726	{
727	int rc = VINF_SUCCESS;
728	va_list va;
729	va_start(va, pszFormat);
730	if (pImage->pInterfaceError)
731	rc = pImage->pInterfaceErrorCallbacks->pfnMessage(pImage->pInterfaceError->pvUser,
732	pszFormat, va);
733	va_end(va);
734	return rc;
735	}
736
737	DECLINLINE(bool) iscsiIsClientConnected(PISCSIIMAGE pImage)
738	{
739	return pImage->Socket != NIL_VDSOCKET
740	&& pImage->pInterfaceNetCallbacks->pfnIsClientConnected(pImage->Socket);
741	}
742
743	/**
744	* Calculates the hash for the given ITT used
745	* to look up the command in the table.
746	*/
747	DECLINLINE(uint32_t) iscsiIttHash(uint32_t Itt)
748	{
749	return Itt % ISCSI_CMD_WAITING_ENTRIES;
750	}
751
752	static PISCSICMD iscsiCmdGetFromItt(PISCSIIMAGE pImage, uint32_t Itt)
753	{
754	PISCSICMD pIScsiCmd = NULL;
755
756	pIScsiCmd = pImage->aCmdsWaiting[iscsiIttHash(Itt)];
757
758	while ( pIScsiCmd
759	&& pIScsiCmd->Itt != Itt)
760	pIScsiCmd = pIScsiCmd->pNext;
761
762	return pIScsiCmd;
763	}
764
765	static void iscsiCmdInsert(PISCSIIMAGE pImage, PISCSICMD pIScsiCmd)
766	{
767	PISCSICMD pIScsiCmdOld;
768	uint32_t idx = iscsiIttHash(pIScsiCmd->Itt);
769
770	Assert(!pIScsiCmd->pNext);
771
772	pIScsiCmdOld = pImage->aCmdsWaiting[idx];
773	pIScsiCmd->pNext = pIScsiCmdOld;
774	pImage->aCmdsWaiting[idx] = pIScsiCmd;
775	pImage->cCmdsWaiting++;
776	}
777
778	static PISCSICMD iscsiCmdRemove(PISCSIIMAGE pImage, uint32_t Itt)
779	{
780	PISCSICMD pIScsiCmd = NULL;
781	PISCSICMD pIScsiCmdPrev = NULL;
782	uint32_t idx = iscsiIttHash(Itt);
783
784	pIScsiCmd = pImage->aCmdsWaiting[idx];
785
786	while ( pIScsiCmd
787	&& pIScsiCmd->Itt != Itt)
788	{
789	pIScsiCmdPrev = pIScsiCmd;
790	pIScsiCmd = pIScsiCmd->pNext;
791	}
792
793	if (pIScsiCmd)
794	{
795	if (pIScsiCmdPrev)
796	{
797	Assert(!pIScsiCmd->pNext \|\| VALID_PTR(pIScsiCmd->pNext));
798	pIScsiCmdPrev->pNext = pIScsiCmd->pNext;
799	}
800	else
801	{
802	pImage->aCmdsWaiting[idx] = pIScsiCmd->pNext;
803	Assert(!pImage->aCmdsWaiting[idx] \|\| VALID_PTR(pImage->aCmdsWaiting[idx]));
804	}
805	pImage->cCmdsWaiting--;
806	}
807
808	return pIScsiCmd;
809	}
810
811	/**
812	* Removes all commands from the table and returns the
813	* list head
814	*
815	* @returns Pointer to the head of teh command list.
816	* @param pImage iSCSI connection to use.
817	*/
818	static PISCSICMD iscsiCmdRemoveAll(PISCSIIMAGE pImage)
819	{
820	PISCSICMD pIScsiCmdHead = NULL;
821
822	for (unsigned idx = 0; idx < RT_ELEMENTS(pImage->aCmdsWaiting); idx++)
823	{
824	PISCSICMD pHead;
825	PISCSICMD pTail;
826
827	pHead = pImage->aCmdsWaiting[idx];
828	pImage->aCmdsWaiting[idx] = NULL;
829
830	if (pHead)
831	{
832	/* Get the tail. */
833	pTail = pHead;
834	while (pTail->pNext)
835	pTail = pTail->pNext;
836
837	/* Concatenate. */
838	pTail->pNext = pIScsiCmdHead;
839	pIScsiCmdHead = pHead;
840	}
841	}
842	pImage->cCmdsWaiting = 0;
843
844	return pIScsiCmdHead;
845	}
846
847	static int iscsiTransportConnect(PISCSIIMAGE pImage)
848	{
849	int rc;
850	if (!pImage->pszHostname)
851	return VERR_NET_DEST_ADDRESS_REQUIRED;
852
853	rc = pImage->pInterfaceNetCallbacks->pfnClientConnect(pImage->Socket, pImage->pszHostname, pImage->uPort);
854	if (RT_FAILURE(rc))
855	{
856	if ( rc == VERR_NET_CONNECTION_REFUSED
857	\|\| rc == VERR_NET_CONNECTION_RESET
858	\|\| rc == VERR_NET_UNREACHABLE
859	\|\| rc == VERR_NET_HOST_UNREACHABLE
860	\|\| rc == VERR_NET_CONNECTION_TIMED_OUT)
861	{
862	/* Standardize return value for no connection. */
863	rc = VERR_NET_CONNECTION_REFUSED;
864	}
865	return rc;
866	}
867
868	/* Disable Nagle algorithm, we want things to be sent immediately. */
869	pImage->pInterfaceNetCallbacks->pfnSetSendCoalescing(pImage->Socket, false);
870
871	/* Make initiator name and ISID unique on this host. */
872	RTNETADDR LocalAddr;
873	rc = pImage->pInterfaceNetCallbacks->pfnGetLocalAddress(pImage->Socket,
874	&LocalAddr);
875	if (RT_FAILURE(rc))
876	return rc;
877	if ( LocalAddr.uPort == RTNETADDR_PORT_NA
878	\|\| LocalAddr.uPort > 65535)
879	return VERR_NET_ADDRESS_FAMILY_NOT_SUPPORTED;
880	pImage->ISID &= ~65535ULL;
881	pImage->ISID \|= LocalAddr.uPort;
882	/* Eliminate the port so that it isn't included below. */
883	LocalAddr.uPort = RTNETADDR_PORT_NA;
884	if (pImage->fAutomaticInitiatorName)
885	{
886	if (pImage->pszInitiatorName)
887	RTStrFree(pImage->pszInitiatorName);
888	RTStrAPrintf(&pImage->pszInitiatorName, "%s:01:%RTnaddr",
889	s_iscsiDefaultInitiatorBasename, &LocalAddr);
890	if (!pImage->pszInitiatorName)
891	return VERR_NO_MEMORY;
892	}
893	return VINF_SUCCESS;
894	}
895
896
897	static int iscsiTransportRead(PISCSIIMAGE pImage, PISCSIRES paResponse, unsigned int cnResponse)
898	{
899	int rc = VINF_SUCCESS;
900	unsigned int i = 0;
901	size_t cbToRead, cbActuallyRead, residual, cbSegActual = 0, cbAHSLength, cbDataLength;
902	char *pDst;
903
904	LogFlowFunc(("cnResponse=%d (%s:%d)\n", cnResponse, pImage->pszHostname, pImage->uPort));
905	if (!iscsiIsClientConnected(pImage))
906	{
907	/* Reconnecting makes no sense in this case, as there will be nothing
908	* to receive. We would just run into a timeout. */
909	rc = VERR_BROKEN_PIPE;
910	}
911
912	if (RT_SUCCESS(rc) && paResponse[0].cbSeg >= ISCSI_BHS_SIZE)
913	{
914	cbToRead = 0;
915	residual = ISCSI_BHS_SIZE; /* Do not read more than the BHS length before the true PDU length is known. */
916	cbSegActual = residual;
917	pDst = (char *)paResponse[i].pvSeg;
918	uint64_t u64Timeout = RTTimeMilliTS() + pImage->uReadTimeout;
919	do
920	{
921	int64_t cMilliesRemaining = u64Timeout - RTTimeMilliTS();
922	if (cMilliesRemaining <= 0)
923	{
924	rc = VERR_TIMEOUT;
925	break;
926	}
927	Assert(cMilliesRemaining < 1000000);
928	rc = pImage->pInterfaceNetCallbacks->pfnSelectOne(pImage->Socket,
929	cMilliesRemaining);
930	if (RT_FAILURE(rc))
931	break;
932	rc = pImage->pInterfaceNetCallbacks->pfnRead(pImage->Socket,
933	pDst, residual,
934	&cbActuallyRead);
935	if (RT_FAILURE(rc))
936	break;
937	if (cbActuallyRead == 0)
938	{
939	/* The other end has closed the connection. */
940	pImage->pInterfaceNetCallbacks->pfnClientClose(pImage->Socket);
941	pImage->state = ISCSISTATE_FREE;
942	rc = VERR_NET_CONNECTION_RESET;
943	break;
944	}
945	if (cbToRead == 0)
946	{
947	/* Currently reading the BHS. */
948	residual -= cbActuallyRead;
949	pDst += cbActuallyRead;
950	if (residual <= 40)
951	{
952	/* Enough data read to figure out the actual PDU size. */
953	uint32_t word1 = RT_N2H_U32(((uint32_t *)(paResponse[0].pvSeg))[1]);
954	cbAHSLength = (word1 & 0xff000000) >> 24;
955	cbAHSLength = ((cbAHSLength - 1) \| 3) + 1; /* Add padding. */
956	cbDataLength = word1 & 0x00ffffff;
957	cbDataLength = ((cbDataLength - 1) \| 3) + 1; /* Add padding. */
958	cbToRead = residual + cbAHSLength + cbDataLength;
959	residual += paResponse[0].cbSeg - ISCSI_BHS_SIZE;
960	if (residual > cbToRead)
961	residual = cbToRead;
962	cbSegActual = ISCSI_BHS_SIZE + cbAHSLength + cbDataLength;
963	/* Check whether we are already done with this PDU (no payload). */
964	if (cbToRead == 0)
965	break;
966	}
967	}
968	else
969	{
970	cbToRead -= cbActuallyRead;
971	if (cbToRead == 0)
972	break;
973	pDst += cbActuallyRead;
974	residual -= cbActuallyRead;
975	}
976	if (residual == 0)
977	{
978	i++;
979	if (i >= cnResponse)
980	{
981	/* No space left in receive buffers. */
982	rc = VERR_BUFFER_OVERFLOW;
983	break;
984	}
985	pDst = (char *)paResponse[i].pvSeg;
986	residual = paResponse[i].cbSeg;
987	if (residual > cbToRead)
988	residual = cbToRead;
989	cbSegActual = residual;
990	}
991	LogFlowFunc(("cbToRead=%u residual=%u cbSegActual=%u cbActuallRead=%u\n",
992	cbToRead, residual, cbSegActual, cbActuallyRead));
993	} while (true);
994	}
995	else
996	{
997	if (RT_SUCCESS(rc))
998	rc = VERR_BUFFER_OVERFLOW;
999	}
1000	if (RT_SUCCESS(rc))
1001	{
1002	paResponse[i].cbSeg = cbSegActual;
1003	for (i++; i < cnResponse; i++)
1004	paResponse[i].cbSeg = 0;
1005	}
1006
1007	if (RT_UNLIKELY( RT_FAILURE(rc)
1008	&& ( rc == VERR_NET_CONNECTION_RESET
1009	\|\| rc == VERR_NET_CONNECTION_ABORTED
1010	\|\| rc == VERR_NET_CONNECTION_RESET_BY_PEER
1011	\|\| rc == VERR_NET_CONNECTION_REFUSED
1012	\|\| rc == VERR_BROKEN_PIPE)))
1013	{
1014	/* Standardize return value for broken connection. */
1015	rc = VERR_BROKEN_PIPE;
1016	}
1017
1018	LogFlowFunc(("returns %Rrc\n", rc));
1019	return rc;
1020	}
1021
1022
1023	static int iscsiTransportWrite(PISCSIIMAGE pImage, PISCSIREQ paRequest, unsigned int cnRequest)
1024	{
1025	int rc = VINF_SUCCESS;
1026	uint32_t pad = 0;
1027	unsigned int i;
1028
1029	LogFlowFunc(("cnRequest=%d (%s:%d)\n", cnRequest, pImage->pszHostname, pImage->uPort));
1030	if (!iscsiIsClientConnected(pImage))
1031	{
1032	/* Attempt to reconnect if the connection was previously broken. */
1033	rc = iscsiTransportConnect(pImage);
1034	}
1035
1036	if (RT_SUCCESS(rc))
1037	{
1038	/* Construct scatter/gather buffer for entire request, worst case
1039	* needs twice as many entries to allow for padding. */
1040	unsigned cBuf = 0;
1041	for (i = 0; i < cnRequest; i++)
1042	{
1043	cBuf++;
1044	if (paRequest[i].cbSeg & 3)
1045	cBuf++;
1046	}
1047	Assert(cBuf < ISCSI_SG_SEGMENTS_MAX);
1048	RTSGBUF buf;
1049	RTSGSEG aSeg[ISCSI_SG_SEGMENTS_MAX];
1050	static char aPad[4] = { 0, 0, 0, 0 };
1051	RTSgBufInit(&buf, &aSeg[0], cBuf);
1052	unsigned iBuf = 0;
1053	for (i = 0; i < cnRequest; i++)
1054	{
1055	/* Actual data chunk. */
1056	aSeg[iBuf].pvSeg = (void *)paRequest[i].pcvSeg;
1057	aSeg[iBuf].cbSeg = paRequest[i].cbSeg;
1058	iBuf++;
1059	/* Insert proper padding before the next chunk. */
1060	if (paRequest[i].cbSeg & 3)
1061	{
1062	aSeg[iBuf].pvSeg = &aPad[0];
1063	aSeg[iBuf].cbSeg = 4 - (paRequest[i].cbSeg & 3);
1064	iBuf++;
1065	}
1066	}
1067	/* Send out the request, the socket is set to send data immediately,
1068	* avoiding unnecessary delays. */
1069	rc = pImage->pInterfaceNetCallbacks->pfnSgWrite(pImage->Socket, &buf);
1070
1071	}
1072
1073	if (RT_UNLIKELY( RT_FAILURE(rc)
1074	&& ( rc == VERR_NET_CONNECTION_RESET
1075	\|\| rc == VERR_NET_CONNECTION_ABORTED
1076	\|\| rc == VERR_NET_CONNECTION_RESET_BY_PEER
1077	\|\| rc == VERR_NET_CONNECTION_REFUSED
1078	\|\| rc == VERR_BROKEN_PIPE)))
1079	{
1080	/* Standardize return value for broken connection. */
1081	rc = VERR_BROKEN_PIPE;
1082	}
1083
1084	LogFlowFunc(("returns %Rrc\n", rc));
1085	return rc;
1086	}
1087
1088
1089	static int iscsiTransportOpen(PISCSIIMAGE pImage)
1090	{
1091	int rc = VINF_SUCCESS;
1092	size_t cbHostname = 0; /* shut up gcc */
1093	const char pcszPort = NULL; / shut up gcc */
1094	char *pszPortEnd;
1095	uint16_t uPort;
1096
1097	/* Clean up previous connection data. */
1098	if (iscsiIsClientConnected(pImage))
1099	{
1100	pImage->pInterfaceNetCallbacks->pfnClientClose(pImage->Socket);
1101	}
1102	if (pImage->pszHostname)
1103	{
1104	RTMemFree(pImage->pszHostname);
1105	pImage->pszHostname = NULL;
1106	pImage->uPort = 0;
1107	}
1108
1109	/* Locate the port number via the colon separating the hostname from the port. */
1110	if (*pImage->pszTargetAddress)
1111	{
1112	if (*pImage->pszTargetAddress != '[')
1113	{
1114	/* Normal hostname or IPv4 dotted decimal. */
1115	pcszPort = strchr(pImage->pszTargetAddress, ':');
1116	if (pcszPort != NULL)
1117	{
1118	cbHostname = pcszPort - pImage->pszTargetAddress;
1119	pcszPort++;
1120	}
1121	else
1122	cbHostname = strlen(pImage->pszTargetAddress);
1123	}
1124	else
1125	{
1126	/* IPv6 literal address. Contains colons, so skip to closing square bracket. */
1127	pcszPort = strchr(pImage->pszTargetAddress, ']');
1128	if (pcszPort != NULL)
1129	{
1130	pcszPort++;
1131	cbHostname = pcszPort - pImage->pszTargetAddress;
1132	if (*pcszPort == '\0')
1133	pcszPort = NULL;
1134	else if (*pcszPort != ':')
1135	rc = VERR_PARSE_ERROR;
1136	else
1137	pcszPort++;
1138	}
1139	else
1140	rc = VERR_PARSE_ERROR;
1141	}
1142	}
1143	else
1144	rc = VERR_PARSE_ERROR;
1145
1146	/* Now split address into hostname and port. */
1147	if (RT_SUCCESS(rc))
1148	{
1149	pImage->pszHostname = (char *)RTMemAlloc(cbHostname + 1);
1150	if (!pImage->pszHostname)
1151	rc = VERR_NO_MEMORY;
1152	else
1153	{
1154	memcpy(pImage->pszHostname, pImage->pszTargetAddress, cbHostname);
1155	pImage->pszHostname[cbHostname] = '\0';
1156	if (pcszPort != NULL)
1157	{
1158	rc = RTStrToUInt16Ex(pcszPort, &pszPortEnd, 0, &uPort);
1159	/* Note that RT_SUCCESS() macro to check the rc value is not strict enough in this case. */
1160	if (rc == VINF_SUCCESS && *pszPortEnd == '\0' && uPort != 0)
1161	{
1162	pImage->uPort = uPort;
1163	}
1164	else
1165	{
1166	rc = VERR_PARSE_ERROR;
1167	}
1168	}
1169	else
1170	pImage->uPort = ISCSI_DEFAULT_PORT;
1171	}
1172	}
1173
1174	if (RT_SUCCESS(rc))
1175	{
1176	if (!iscsiIsClientConnected(pImage))
1177	rc = iscsiTransportConnect(pImage);
1178	}
1179	else
1180	{
1181	if (pImage->pszHostname)
1182	{
1183	RTMemFree(pImage->pszHostname);
1184	pImage->pszHostname = NULL;
1185	}
1186	pImage->uPort = 0;
1187	}
1188
1189	LogFlowFunc(("returns %Rrc\n", rc));
1190	return rc;
1191	}
1192
1193
1194	static int iscsiTransportClose(PISCSIIMAGE pImage)
1195	{
1196	int rc;
1197
1198	LogFlowFunc(("(%s:%d)\n", pImage->pszHostname, pImage->uPort));
1199	if (iscsiIsClientConnected(pImage))
1200	{
1201	rc = pImage->pInterfaceNetCallbacks->pfnClientClose(pImage->Socket);
1202	}
1203	else
1204	rc = VINF_SUCCESS;
1205	LogFlowFunc(("returns %Rrc\n", rc));
1206	return rc;
1207	}
1208
1209
1210	/**
1211	* Attach to an iSCSI target. Performs all operations necessary to enter
1212	* Full Feature Phase.
1213	*
1214	* @returns VBox status.
1215	* @param pImage The iSCSI connection state to be used.
1216	*/
1217	static int iscsiAttach(void *pvUser)
1218	{
1219	int rc;
1220	uint32_t itt;
1221	uint32_t csg, nsg, substate;
1222	uint64_t isid_tsih;
1223	uint8_t bBuf[4096]; /* Should be large enough even for large authentication values. */
1224	size_t cbBuf;
1225	bool transit;
1226	uint8_t pbChallenge[1024]; /* RFC3720 specifies this as maximum. */
1227	size_t cbChallenge = 0; /* shut up gcc */
1228	uint8_t bChapIdx;
1229	uint8_t aResponse[RTMD5HASHSIZE];
1230	uint32_t cnISCSIReq;
1231	ISCSIREQ aISCSIReq[4];
1232	uint32_t aReqBHS[12];
1233	uint32_t cnISCSIRes;
1234	ISCSIRES aISCSIRes[2];
1235	uint32_t aResBHS[12];
1236	char *pszNext;
1237	PISCSIIMAGE pImage = (PISCSIIMAGE)pvUser;
1238
1239	bool fParameterNeg = true;;
1240	pImage->cbRecvDataLength = ISCSI_DATA_LENGTH_MAX;
1241	pImage->cbSendDataLength = RT_MIN(ISCSI_DATA_LENGTH_MAX, pImage->cbWriteSplit);
1242	char szMaxDataLength[16];
1243	RTStrPrintf(szMaxDataLength, sizeof(szMaxDataLength), "%u", ISCSI_DATA_LENGTH_MAX);
1244	ISCSIPARAMETER aParameterNeg[] =
1245	{
1246	{ "HeaderDigest", "None", 0 },
1247	{ "DataDigest", "None", 0 },
1248	{ "MaxConnections", "1", 0 },
1249	{ "InitialR2T", "No", 0 },
1250	{ "ImmediateData", "Yes", 0 },
1251	{ "MaxRecvDataSegmentLength", szMaxDataLength, 0 },
1252	{ "MaxBurstLength", szMaxDataLength, 0 },
1253	{ "FirstBurstLength", szMaxDataLength, 0 },
1254	{ "DefaultTime2Wait", "0", 0 },
1255	{ "DefaultTime2Retain", "60", 0 },
1256	{ "DataPDUInOrder", "Yes", 0 },
1257	{ "DataSequenceInOrder", "Yes", 0 },
1258	{ "ErrorRecoveryLevel", "0", 0 },
1259	{ "MaxOutstandingR2T", "1", 0 }
1260	};
1261
1262	LogFlowFunc(("entering\n"));
1263
1264	Assert(pImage->state == ISCSISTATE_FREE);
1265
1266	RTSemMutexRequest(pImage->Mutex, RT_INDEFINITE_WAIT);
1267
1268	/* Make 100% sure the connection isn't reused for a new login. */
1269	iscsiTransportClose(pImage);
1270
1271	restart:
1272	if (!iscsiIsClientConnected(pImage))
1273	{
1274	rc = iscsiTransportOpen(pImage);
1275	if (RT_FAILURE(rc))
1276	goto out;
1277	}
1278
1279	pImage->state = ISCSISTATE_IN_LOGIN;
1280	pImage->ITT = 1;
1281	pImage->FirstRecvPDU = true;
1282	pImage->CmdSN = 1;
1283	pImage->ExpCmdSN = 0;
1284	pImage->MaxCmdSN = 1;
1285	pImage->ExpStatSN = 0;
1286
1287	/*
1288	* Send login request to target.
1289	*/
1290	itt = iscsiNewITT(pImage);
1291	csg = 0;
1292	nsg = 0;
1293	substate = 0;
1294	isid_tsih = pImage->ISID << 16; /* TSIH field currently always 0 */
1295
1296	do {
1297	transit = false;
1298	cbBuf = 0;
1299	/* Handle all cases with a single switch statement. */
1300	switch (csg << 8 \| substate)
1301	{
1302	case 0x0000: /* security negotiation, step 0: propose authentication. */
1303	rc = iscsiTextAddKeyValue(bBuf, sizeof(bBuf), &cbBuf, "SessionType", "Normal", 0);
1304	if (RT_FAILURE(rc))
1305	goto out;
1306	rc = iscsiTextAddKeyValue(bBuf, sizeof(bBuf), &cbBuf, "InitiatorName", pImage->pszInitiatorName, 0);
1307	if (RT_FAILURE(rc))
1308	goto out;
1309	rc = iscsiTextAddKeyValue(bBuf, sizeof(bBuf), &cbBuf, "TargetName", pImage->pszTargetName, 0);
1310	if (RT_FAILURE(rc))
1311	goto out;
1312	if (pImage->pszInitiatorUsername == NULL)
1313	{
1314	/* No authentication. Immediately switch to next phase. */
1315	rc = iscsiTextAddKeyValue(bBuf, sizeof(bBuf), &cbBuf, "AuthMethod", "None", 0);
1316	if (RT_FAILURE(rc))
1317	goto out;
1318	nsg = 1;
1319	transit = true;
1320	}
1321	else
1322	{
1323	rc = iscsiTextAddKeyValue(bBuf, sizeof(bBuf), &cbBuf, "AuthMethod", "CHAP,None", 0);
1324	if (RT_FAILURE(rc))
1325	goto out;
1326	}
1327	break;
1328	case 0x0001: /* security negotiation, step 1: propose CHAP_MD5 variant. */
1329	rc = iscsiTextAddKeyValue(bBuf, sizeof(bBuf), &cbBuf, "CHAP_A", "5", 0);
1330	if (RT_FAILURE(rc))
1331	goto out;
1332	break;
1333	case 0x0002: /* security negotiation, step 2: send authentication info. */
1334	rc = iscsiTextAddKeyValue(bBuf, sizeof(bBuf), &cbBuf, "CHAP_N", pImage->pszInitiatorUsername, 0);
1335	if (RT_FAILURE(rc))
1336	goto out;
1337	chap_md5_compute_response(aResponse, bChapIdx, pbChallenge, cbChallenge,
1338	pImage->pbInitiatorSecret, pImage->cbInitiatorSecret);
1339	rc = iscsiTextAddKeyValue(bBuf, sizeof(bBuf), &cbBuf, "CHAP_R", (const char *)aResponse, RTMD5HASHSIZE);
1340	if (RT_FAILURE(rc))
1341	goto out;
1342	nsg = 1;
1343	transit = true;
1344	break;
1345	case 0x0100: /* login operational negotiation, step 0: set parameters. */
1346	if (fParameterNeg)
1347	{
1348	for (unsigned i = 0; i < RT_ELEMENTS(aParameterNeg); i++)
1349	{
1350	rc = iscsiTextAddKeyValue(bBuf, sizeof(bBuf), &cbBuf,
1351	aParameterNeg[i].pszParamName,
1352	aParameterNeg[i].pszParamValue,
1353	aParameterNeg[i].cbParamValue);
1354	if (RT_FAILURE(rc))
1355	goto out;
1356	}
1357	fParameterNeg = false;
1358	}
1359
1360	nsg = 3;
1361	transit = true;
1362	break;
1363	case 0x0300: /* full feature phase. */
1364	default:
1365	/* Should never come here. */
1366	AssertMsgFailed(("send: Undefined login state %d substate %d\n", csg, substate));
1367	break;
1368	}
1369
1370	aReqBHS[0] = RT_H2N_U32( ISCSI_IMMEDIATE_DELIVERY_BIT
1371	\| (csg << ISCSI_CSG_SHIFT)
1372	\| (transit ? (nsg << ISCSI_NSG_SHIFT \| ISCSI_TRANSIT_BIT) : 0)
1373	\| ISCSI_MY_VERSION /* Minimum version. */
1374	\| (ISCSI_MY_VERSION << 8) /* Maximum version. */
1375	\| ISCSIOP_LOGIN_REQ); /* C=0 */
1376	aReqBHS[1] = RT_H2N_U32((uint32_t)cbBuf); /* TotalAHSLength=0 */
1377	aReqBHS[2] = RT_H2N_U32(isid_tsih >> 32);
1378	aReqBHS[3] = RT_H2N_U32(isid_tsih & 0xffffffff);
1379	aReqBHS[4] = itt;
1380	aReqBHS[5] = RT_H2N_U32(1 << 16); /* CID=1,reserved */
1381	aReqBHS[6] = RT_H2N_U32(pImage->CmdSN);
1382	aReqBHS[7] = RT_H2N_U32(pImage->ExpStatSN);
1383	aReqBHS[8] = 0; /* reserved */
1384	aReqBHS[9] = 0; /* reserved */
1385	aReqBHS[10] = 0; /* reserved */
1386	aReqBHS[11] = 0; /* reserved */
1387
1388	cnISCSIReq = 0;
1389	aISCSIReq[cnISCSIReq].pcvSeg = aReqBHS;
1390	aISCSIReq[cnISCSIReq].cbSeg = sizeof(aReqBHS);
1391	cnISCSIReq++;
1392
1393	aISCSIReq[cnISCSIReq].pcvSeg = bBuf;
1394	aISCSIReq[cnISCSIReq].cbSeg = cbBuf;
1395	cnISCSIReq++;
1396
1397	rc = iscsiSendPDU(pImage, aISCSIReq, cnISCSIReq, ISCSIPDU_NO_REATTACH);
1398	if (RT_SUCCESS(rc))
1399	{
1400	ISCSIOPCODE cmd;
1401	ISCSILOGINSTATUSCLASS loginStatusClass;
1402
1403	cnISCSIRes = 0;
1404	aISCSIRes[cnISCSIRes].pvSeg = aResBHS;
1405	aISCSIRes[cnISCSIRes].cbSeg = sizeof(aResBHS);
1406	cnISCSIRes++;
1407	aISCSIRes[cnISCSIRes].pvSeg = bBuf;
1408	aISCSIRes[cnISCSIRes].cbSeg = sizeof(bBuf);
1409	cnISCSIRes++;
1410
1411	rc = iscsiRecvPDU(pImage, itt, aISCSIRes, cnISCSIRes);
1412	if (RT_FAILURE(rc))
1413	break;
1414	/** @todo collect partial login responses with Continue bit set. */
1415	Assert(aISCSIRes[0].pvSeg == aResBHS);
1416	Assert(aISCSIRes[0].cbSeg >= ISCSI_BHS_SIZE);
1417	Assert((RT_N2H_U32(aResBHS[0]) & ISCSI_CONTINUE_BIT) == 0);
1418
1419	cmd = (ISCSIOPCODE)(RT_N2H_U32(aResBHS[0]) & ISCSIOP_MASK);
1420	if (cmd == ISCSIOP_LOGIN_RES)
1421	{
1422	if ((RT_N2H_U32(aResBHS[0]) & 0xff) != ISCSI_MY_VERSION)
1423	{
1424	iscsiTransportClose(pImage);
1425	rc = VERR_PARSE_ERROR;
1426	break; /* Give up immediately, as a RFC violation in version fields is very serious. */
1427	}
1428
1429	loginStatusClass = (ISCSILOGINSTATUSCLASS)(RT_N2H_U32(aResBHS[9]) >> 24);
1430	switch (loginStatusClass)
1431	{
1432	case ISCSI_LOGIN_STATUS_CLASS_SUCCESS:
1433	uint32_t targetCSG;
1434	uint32_t targetNSG;
1435	bool targetTransit;
1436
1437	if (pImage->FirstRecvPDU)
1438	{
1439	pImage->FirstRecvPDU = false;
1440	pImage->ExpStatSN = RT_N2H_U32(aResBHS[6]) + 1;
1441	}
1442
1443	targetCSG = (RT_N2H_U32(aResBHS[0]) & ISCSI_CSG_MASK) >> ISCSI_CSG_SHIFT;
1444	targetNSG = (RT_N2H_U32(aResBHS[0]) & ISCSI_NSG_MASK) >> ISCSI_NSG_SHIFT;
1445	targetTransit = !!(RT_N2H_U32(aResBHS[0]) & ISCSI_TRANSIT_BIT);
1446
1447	/* Handle all cases with a single switch statement. */
1448	switch (csg << 8 \| substate)
1449	{
1450	case 0x0000: /* security negotiation, step 0: receive final authentication. */
1451	rc = iscsiUpdateParameters(pImage, bBuf, aISCSIRes[1].cbSeg);
1452	if (RT_FAILURE(rc))
1453	break;
1454
1455	const char *pcszAuthMethod;
1456
1457	rc = iscsiTextGetKeyValue(bBuf, aISCSIRes[1].cbSeg, "AuthMethod", &pcszAuthMethod);
1458	if (RT_FAILURE(rc))
1459	{
1460	rc = VERR_PARSE_ERROR;
1461	break;
1462	}
1463	if (strcmp(pcszAuthMethod, "None") == 0)
1464	{
1465	/* Authentication offered, but none required. Skip to operational parameters. */
1466	csg = 1;
1467	nsg = 1;
1468	transit = true;
1469	substate = 0;
1470	break;
1471	}
1472	else if (strcmp(pcszAuthMethod, "CHAP") == 0 && targetNSG == 0 && !targetTransit)
1473	{
1474	/* CHAP authentication required, continue with next substate. */
1475	substate++;
1476	break;
1477	}
1478
1479	/* Unknown auth method or login response PDU headers incorrect. */
1480	rc = VERR_PARSE_ERROR;
1481	break;
1482	case 0x0001: /* security negotiation, step 1: receive final CHAP variant and challenge. */
1483	rc = iscsiUpdateParameters(pImage, bBuf, aISCSIRes[1].cbSeg);
1484	if (RT_FAILURE(rc))
1485	break;
1486
1487	const char *pcszChapAuthMethod;
1488	const char *pcszChapIdxTarget;
1489	const char *pcszChapChallengeStr;
1490
1491	rc = iscsiTextGetKeyValue(bBuf, aISCSIRes[1].cbSeg, "CHAP_A", &pcszChapAuthMethod);
1492	if (RT_FAILURE(rc))
1493	{
1494	rc = VERR_PARSE_ERROR;
1495	break;
1496	}
1497	if (strcmp(pcszChapAuthMethod, "5") != 0)
1498	{
1499	rc = VERR_PARSE_ERROR;
1500	break;
1501	}
1502	rc = iscsiTextGetKeyValue(bBuf, aISCSIRes[1].cbSeg, "CHAP_I", &pcszChapIdxTarget);
1503	if (RT_FAILURE(rc))
1504	{
1505	rc = VERR_PARSE_ERROR;
1506	break;
1507	}
1508	rc = RTStrToUInt8Ex(pcszChapIdxTarget, &pszNext, 0, &bChapIdx);
1509	if ((rc > VINF_SUCCESS) \|\| *pszNext != '\0')
1510	{
1511	rc = VERR_PARSE_ERROR;
1512	break;
1513	}
1514	rc = iscsiTextGetKeyValue(bBuf, aISCSIRes[1].cbSeg, "CHAP_C", &pcszChapChallengeStr);
1515	if (RT_FAILURE(rc))
1516	{
1517	rc = VERR_PARSE_ERROR;
1518	break;
1519	}
1520	cbChallenge = sizeof(pbChallenge);
1521	rc = iscsiStrToBinary(pcszChapChallengeStr, pbChallenge, &cbChallenge);
1522	if (RT_FAILURE(rc))
1523	break;
1524	substate++;
1525	transit = true;
1526	break;
1527	case 0x0002: /* security negotiation, step 2: check authentication success. */
1528	rc = iscsiUpdateParameters(pImage, bBuf, aISCSIRes[1].cbSeg);
1529	if (RT_FAILURE(rc))
1530	break;
1531
1532	if (targetCSG == 0 && targetNSG == 1 && targetTransit)
1533	{
1534	/* Target wants to continue in login operational state, authentication success. */
1535	csg = 1;
1536	nsg = 3;
1537	substate = 0;
1538	break;
1539	}
1540	rc = VERR_PARSE_ERROR;
1541	break;
1542	case 0x0100: /* login operational negotiation, step 0: check results. */
1543	rc = iscsiUpdateParameters(pImage, bBuf, aISCSIRes[1].cbSeg);
1544	if (RT_FAILURE(rc))
1545	break;
1546
1547	if (targetCSG == 1 && targetNSG == 3 && targetTransit)
1548	{
1549	/* Target wants to continue in full feature phase, login finished. */
1550	csg = 3;
1551	nsg = 3;
1552	substate = 0;
1553	break;
1554	}
1555	else if (targetCSG == 1 && targetNSG == 1 && !targetTransit)
1556	{
1557	/* Target wants to negotiate certain parameters and
1558	* stay in login operational negotiation. */
1559	csg = 1;
1560	nsg = 3;
1561	substate = 0;
1562	}
1563	rc = VERR_PARSE_ERROR;
1564	break;
1565	case 0x0300: /* full feature phase. */
1566	default:
1567	AssertMsgFailed(("recv: Undefined login state %d substate %d\n", csg, substate));
1568	rc = VERR_PARSE_ERROR;
1569	break;
1570	}
1571	break;
1572	case ISCSI_LOGIN_STATUS_CLASS_REDIRECTION:
1573	const char *pcszTargetRedir;
1574
1575	/* Target has moved to some other location, as indicated in the TargetAddress key. */
1576	rc = iscsiTextGetKeyValue(bBuf, aISCSIRes[1].cbSeg, "TargetAddress", &pcszTargetRedir);
1577	if (RT_FAILURE(rc))
1578	{
1579	rc = VERR_PARSE_ERROR;
1580	break;
1581	}
1582	if (pImage->pszTargetAddress)
1583	RTMemFree(pImage->pszTargetAddress);
1584	{
1585	size_t cb = strlen(pcszTargetRedir) + 1;
1586	pImage->pszTargetAddress = (char *)RTMemAlloc(cb);
1587	if (!pImage->pszTargetAddress)
1588	{
1589	rc = VERR_NO_MEMORY;
1590	break;
1591	}
1592	memcpy(pImage->pszTargetAddress, pcszTargetRedir, cb);
1593	}
1594	rc = iscsiTransportOpen(pImage);
1595	goto restart;
1596	case ISCSI_LOGIN_STATUS_CLASS_INITIATOR_ERROR:
1597	iscsiTransportClose(pImage);
1598	rc = VERR_IO_GEN_FAILURE;
1599	goto out;
1600	case ISCSI_LOGIN_STATUS_CLASS_TARGET_ERROR:
1601	iscsiTransportClose(pImage);
1602	rc = VINF_EOF;
1603	break;
1604	default:
1605	rc = VERR_PARSE_ERROR;
1606	}
1607
1608	if (csg == 3)
1609	{
1610	/*
1611	* Finished login, continuing with Full Feature Phase.
1612	*/
1613	rc = VINF_SUCCESS;
1614	break;
1615	}
1616	}
1617	else
1618	{
1619	AssertMsgFailed(("%s: ignoring unexpected PDU with first word = %#08x\n", __FUNCTION__, RT_N2H_U32(aResBHS[0])));
1620	}
1621	}
1622	else
1623	break;
1624	} while (true);
1625
1626	out:
1627	if (RT_FAILURE(rc))
1628	{
1629	/*
1630	* Close connection to target.
1631	*/
1632	iscsiTransportClose(pImage);
1633	pImage->state = ISCSISTATE_FREE;
1634	}
1635	else
1636	pImage->state = ISCSISTATE_NORMAL;
1637
1638	RTSemMutexRelease(pImage->Mutex);
1639
1640	LogFlowFunc(("returning %Rrc\n", rc));
1641	LogRel(("iSCSI: login to target %s %s\n", pImage->pszTargetName, RT_SUCCESS(rc) ? "successful" : "failed"));
1642	return rc;
1643	}
1644
1645
1646	/**
1647	* Detach from an iSCSI target.
1648	*
1649	* @returns VBox status.
1650	* @param pImage The iSCSI connection state to be used.
1651	*/
1652	static int iscsiDetach(void *pvUser)
1653	{
1654	int rc;
1655	uint32_t itt;
1656	uint32_t cnISCSIReq = 0;
1657	ISCSIREQ aISCSIReq[4];
1658	uint32_t aReqBHS[12];
1659	PISCSIIMAGE pImage = (PISCSIIMAGE)pvUser;
1660
1661	LogFlowFunc(("entering\n"));
1662
1663	RTSemMutexRequest(pImage->Mutex, RT_INDEFINITE_WAIT);
1664
1665	if (pImage->state != ISCSISTATE_FREE && pImage->state != ISCSISTATE_IN_LOGOUT)
1666	{
1667	pImage->state = ISCSISTATE_IN_LOGOUT;
1668
1669	/*
1670	* Send logout request to target.
1671	*/
1672	itt = iscsiNewITT(pImage);
1673	aReqBHS[0] = RT_H2N_U32(ISCSI_FINAL_BIT \| ISCSIOP_LOGOUT_REQ); /* I=0,F=1,Reason=close session */
1674	aReqBHS[1] = RT_H2N_U32(0); /* TotalAHSLength=0,DataSementLength=0 */
1675	aReqBHS[2] = 0; /* reserved */
1676	aReqBHS[3] = 0; /* reserved */
1677	aReqBHS[4] = itt;
1678	aReqBHS[5] = 0; /* reserved */
1679	aReqBHS[6] = RT_H2N_U32(pImage->CmdSN);
1680	aReqBHS[7] = RT_H2N_U32(pImage->ExpStatSN);
1681	aReqBHS[8] = 0; /* reserved */
1682	aReqBHS[9] = 0; /* reserved */
1683	aReqBHS[10] = 0; /* reserved */
1684	aReqBHS[11] = 0; /* reserved */
1685	pImage->CmdSN++;
1686
1687	aISCSIReq[cnISCSIReq].pcvSeg = aReqBHS;
1688	aISCSIReq[cnISCSIReq].cbSeg = sizeof(aReqBHS);
1689	cnISCSIReq++;
1690
1691	rc = iscsiSendPDU(pImage, aISCSIReq, cnISCSIReq, ISCSIPDU_NO_REATTACH);
1692	if (RT_SUCCESS(rc))
1693	{
1694	/*
1695	* Read logout response from target.
1696	*/
1697	ISCSIRES aISCSIRes;
1698	uint32_t aResBHS[12];
1699
1700	aISCSIRes.pvSeg = aResBHS;
1701	aISCSIRes.cbSeg = sizeof(aResBHS);
1702	rc = iscsiRecvPDU(pImage, itt, &aISCSIRes, 1);
1703	if (RT_SUCCESS(rc))
1704	{
1705	if (RT_N2H_U32(aResBHS[0]) != (ISCSI_FINAL_BIT \| ISCSIOP_LOGOUT_RES))
1706	AssertMsgFailed(("iSCSI Logout response invalid\n"));
1707	}
1708	else
1709	AssertMsgFailed(("iSCSI Logout response error, rc=%Rrc\n", rc));
1710	}
1711	else
1712	AssertMsgFailed(("Could not send iSCSI Logout request, rc=%Rrc\n", rc));
1713	}
1714
1715	if (pImage->state != ISCSISTATE_FREE)
1716	{
1717	/*
1718	* Close connection to target.
1719	*/
1720	rc = iscsiTransportClose(pImage);
1721	if (RT_FAILURE(rc))
1722	AssertMsgFailed(("Could not close connection to target, rc=%Rrc\n", rc));
1723	}
1724
1725	pImage->state = ISCSISTATE_FREE;
1726
1727	RTSemMutexRelease(pImage->Mutex);
1728
1729	LogFlowFunc(("leaving\n"));
1730	LogRel(("iSCSI: logout to target %s\n", pImage->pszTargetName));
1731	return VINF_SUCCESS;
1732	}
1733
1734
1735	/**
1736	* Perform a command on an iSCSI target. Target must be already in
1737	* Full Feature Phase.
1738	*
1739	* @returns VBOX status.
1740	* @param pImage The iSCSI connection state to be used.
1741	* @param pRequest Command descriptor. Contains all information about
1742	* the command, its transfer directions and pointers
1743	* to the buffer(s) used for transferring data and
1744	* status information.
1745	*/
1746	static int iscsiCommand(PISCSIIMAGE pImage, PSCSIREQ pRequest)
1747	{
1748	int rc;
1749	uint32_t itt;
1750	uint32_t cbData;
1751	uint32_t cnISCSIReq = 0;
1752	ISCSIREQ aISCSIReq[4];
1753	uint32_t aReqBHS[12];
1754
1755	uint32_t *pDst = NULL;
1756	size_t cbBufLength;
1757	uint32_t aStatus[256]; /*< Plenty of buffer for status information. /
1758	uint32_t ExpDataSN = 0;
1759	bool final = false;
1760
1761
1762	LogFlowFunc(("entering, CmdSN=%d\n", pImage->CmdSN));
1763
1764	Assert(pRequest->enmXfer != SCSIXFER_TO_FROM_TARGET); /*< @todo not yet supported, would require AHS. /
1765	Assert(pRequest->cbI2TData <= 0xffffff); /* larger transfers would require R2T support. */
1766	Assert(pRequest->cbCDB <= 16); /* would cause buffer overrun below. */
1767
1768	/* If not in normal state, then the transport connection was dropped. Try
1769	* to reestablish by logging in, the target might be responsive again. */
1770	if (pImage->state == ISCSISTATE_FREE)
1771	rc = iscsiAttach(pImage);
1772
1773	/* If still not in normal state, then the underlying transport connection
1774	* cannot be established. Get out before bad things happen (and make
1775	* sure the caller suspends the VM again). */
1776	if (pImage->state != ISCSISTATE_NORMAL)
1777	{
1778	rc = VERR_NET_CONNECTION_REFUSED;
1779	goto out;
1780	}
1781
1782	/*
1783	* Send SCSI command to target with all I2T data included.
1784	*/
1785	cbData = 0;
1786	if (pRequest->enmXfer == SCSIXFER_FROM_TARGET)
1787	cbData = (uint32_t)pRequest->cbT2IData;
1788	else
1789	cbData = (uint32_t)pRequest->cbI2TData;
1790
1791	RTSemMutexRequest(pImage->Mutex, RT_INDEFINITE_WAIT);
1792
1793	itt = iscsiNewITT(pImage);
1794	memset(aReqBHS, 0, sizeof(aReqBHS));
1795	aReqBHS[0] = RT_H2N_U32( ISCSI_FINAL_BIT \| ISCSI_TASK_ATTR_ORDERED \| ISCSIOP_SCSI_CMD
1796	\| (pRequest->enmXfer << 21)); /* I=0,F=1,Attr=Ordered */
1797	aReqBHS[1] = RT_H2N_U32(0x00000000 \| ((uint32_t)pRequest->cbI2TData & 0xffffff)); /* TotalAHSLength=0 */
1798	aReqBHS[2] = RT_H2N_U32(pImage->LUN >> 32);
1799	aReqBHS[3] = RT_H2N_U32(pImage->LUN & 0xffffffff);
1800	aReqBHS[4] = itt;
1801	aReqBHS[5] = RT_H2N_U32(cbData);
1802	aReqBHS[6] = RT_H2N_U32(pImage->CmdSN);
1803	aReqBHS[7] = RT_H2N_U32(pImage->ExpStatSN);
1804	memcpy(aReqBHS + 8, pRequest->pvCDB, pRequest->cbCDB);
1805	pImage->CmdSN++;
1806
1807	aISCSIReq[cnISCSIReq].pcvSeg = aReqBHS;
1808	aISCSIReq[cnISCSIReq].cbSeg = sizeof(aReqBHS);
1809	cnISCSIReq++;
1810
1811	if ( pRequest->enmXfer == SCSIXFER_TO_TARGET
1812	\|\| pRequest->enmXfer == SCSIXFER_TO_FROM_TARGET)
1813	{
1814	Assert(pRequest->cI2TSegs == 1);
1815	aISCSIReq[cnISCSIReq].pcvSeg = pRequest->paI2TSegs[0].pvSeg;
1816	aISCSIReq[cnISCSIReq].cbSeg = pRequest->paI2TSegs[0].cbSeg; /* Padding done by transport. */
1817	cnISCSIReq++;
1818	}
1819
1820	rc = iscsiSendPDU(pImage, aISCSIReq, cnISCSIReq, ISCSIPDU_DEFAULT);
1821	if (RT_FAILURE(rc))
1822	goto out_release;
1823
1824	/* Place SCSI request in queue. */
1825	pImage->paCurrReq = aISCSIReq;
1826	pImage->cnCurrReq = cnISCSIReq;
1827
1828	/*
1829	* Read SCSI response/data in PDUs from target.
1830	*/
1831	if ( pRequest->enmXfer == SCSIXFER_FROM_TARGET
1832	\|\| pRequest->enmXfer == SCSIXFER_TO_FROM_TARGET)
1833	{
1834	Assert(pRequest->cT2ISegs == 1);
1835	pDst = (uint32_t *)pRequest->paT2ISegs[0].pvSeg;
1836	cbBufLength = pRequest->paT2ISegs[0].cbSeg;
1837	}
1838	else
1839	cbBufLength = 0;
1840
1841	do {
1842	uint32_t cnISCSIRes = 0;
1843	ISCSIRES aISCSIRes[4];
1844	uint32_t aResBHS[12];
1845
1846	aISCSIRes[cnISCSIRes].pvSeg = aResBHS;
1847	aISCSIRes[cnISCSIRes].cbSeg = sizeof(aResBHS);
1848	cnISCSIRes++;
1849	if (cbBufLength != 0 &&
1850	( pRequest->enmXfer == SCSIXFER_FROM_TARGET
1851	\|\| pRequest->enmXfer == SCSIXFER_TO_FROM_TARGET))
1852	{
1853	aISCSIRes[cnISCSIRes].pvSeg = pDst;
1854	aISCSIRes[cnISCSIRes].cbSeg = cbBufLength;
1855	cnISCSIRes++;
1856	}
1857	/* Always reserve space for the status - it's impossible to tell
1858	* beforehand whether this will be the final PDU or not. */
1859	aISCSIRes[cnISCSIRes].pvSeg = aStatus;
1860	aISCSIRes[cnISCSIRes].cbSeg = sizeof(aStatus);
1861	cnISCSIRes++;
1862
1863	rc = iscsiRecvPDU(pImage, itt, aISCSIRes, cnISCSIRes);
1864	if (RT_FAILURE(rc))
1865	break;
1866
1867	final = !!(RT_N2H_U32(aResBHS[0]) & ISCSI_FINAL_BIT);
1868	ISCSIOPCODE cmd = (ISCSIOPCODE)(RT_N2H_U32(aResBHS[0]) & ISCSIOP_MASK);
1869	if (cmd == ISCSIOP_SCSI_RES)
1870	{
1871	/* This is the final PDU which delivers the status (and may be omitted if
1872	* the last Data-In PDU included successful completion status). Note
1873	* that ExpStatSN has been bumped already in iscsiRecvPDU. */
1874	if (!final \|\| ((RT_N2H_U32(aResBHS[0]) & 0x0000ff00) != 0) \|\| (RT_N2H_U32(aResBHS[6]) != pImage->ExpStatSN - 1))
1875	{
1876	/* SCSI Response in the wrong place or with a (target) failure. */
1877	rc = VERR_PARSE_ERROR;
1878	break;
1879	}
1880	/* The following is a bit tricky, as in error situations we may
1881	* get the status only instead of the result data plus optional
1882	* status. Thus the status may have ended up partially in the
1883	* data area. */
1884	pRequest->status = RT_N2H_U32(aResBHS[0]) & 0x000000ff;
1885	cbData = RT_N2H_U32(aResBHS[1]) & 0x00ffffff;
1886	if (cbData >= 2)
1887	{
1888	uint32_t cbStat = RT_N2H_U32(((uint32_t *)aISCSIRes[1].pvSeg)[0]) >> 16;
1889	if (cbStat + 2 > cbData)
1890	{
1891	rc = VERR_BUFFER_OVERFLOW;
1892	break;
1893	}
1894	/* Truncate sense data if it doesn't fit into the buffer. */
1895	pRequest->cbSense = RT_MIN(cbStat, pRequest->cbSense);
1896	memcpy(pRequest->pvSense,
1897	((const char *)aISCSIRes[1].pvSeg) + 2,
1898	RT_MIN(aISCSIRes[1].cbSeg - 2, pRequest->cbSense));
1899	if ( cnISCSIRes > 2 && aISCSIRes[2].cbSeg
1900	&& (ssize_t)pRequest->cbSense - aISCSIRes[1].cbSeg + 2 > 0)
1901	{
1902	memcpy((char *)pRequest->pvSense + aISCSIRes[1].cbSeg - 2,
1903	aISCSIRes[2].pvSeg,
1904	pRequest->cbSense - aISCSIRes[1].cbSeg + 2);
1905	}
1906	}
1907	else if (cbData == 1)
1908	{
1909	rc = VERR_PARSE_ERROR;
1910	break;
1911	}
1912	else
1913	pRequest->cbSense = 0;
1914	break;
1915	}
1916	else if (cmd == ISCSIOP_SCSI_DATA_IN)
1917	{
1918	/* A Data-In PDU carries some data that needs to be added to the received
1919	* data in response to the command. There may be both partial and complete
1920	* Data-In PDUs, so collect data until the status is included or the status
1921	* is sent in a separate SCSI Result frame (see above). */
1922	if (final && aISCSIRes[2].cbSeg != 0)
1923	{
1924	/* The received PDU is partially stored in the buffer for status.
1925	* Must not happen under normal circumstances and is a target error. */
1926	rc = VERR_BUFFER_OVERFLOW;
1927	break;
1928	}
1929	uint32_t len = RT_N2H_U32(aResBHS[1]) & 0x00ffffff;
1930	pDst = (uint32_t )((char )pDst + len);
1931	cbBufLength -= len;
1932	ExpDataSN++;
1933	if (final && (RT_N2H_U32(aResBHS[0]) & ISCSI_STATUS_BIT) != 0)
1934	{
1935	pRequest->status = RT_N2H_U32(aResBHS[0]) & 0x000000ff;
1936	pRequest->cbSense = 0;
1937	break;
1938	}
1939	}
1940	else
1941	{
1942	rc = VERR_PARSE_ERROR;
1943	break;
1944	}
1945	} while (true);
1946
1947	/* Remove SCSI request from queue. */
1948	pImage->paCurrReq = NULL;
1949	pImage->cnCurrReq = 0;
1950
1951	out_release:
1952	if (rc == VERR_TIMEOUT)
1953	{
1954	/* Drop connection in case the target plays dead. Much better than
1955	* delaying the next requests until the timed out command actually
1956	* finishes. Also keep in mind that command shouldn't take longer than
1957	* about 30-40 seconds, or the guest will lose its patience. */
1958	iscsiTransportClose(pImage);
1959	pImage->state = ISCSISTATE_FREE;
1960	}
1961	RTSemMutexRelease(pImage->Mutex);
1962
1963	out:
1964	LogFlowFunc(("returns %Rrc\n", rc));
1965	return rc;
1966	}
1967
1968
1969	/**
1970	* Generate a new Initiator Task Tag.
1971	*
1972	* @returns Initiator Task Tag.
1973	* @param pImage The iSCSI connection state to be used.
1974	*/
1975	static uint32_t iscsiNewITT(PISCSIIMAGE pImage)
1976	{
1977	uint32_t next_itt;
1978
1979	next_itt = pImage->ITT++;
1980	if (pImage->ITT == ISCSI_TASK_TAG_RSVD)
1981	pImage->ITT = 0;
1982	return RT_H2N_U32(next_itt);
1983	}
1984
1985
1986	/**
1987	* Send an iSCSI request. The request can consist of several segments, which
1988	* are padded to 4 byte boundaries and concatenated.
1989	*
1990	* @returns VBOX status
1991	* @param pImage The iSCSI connection state to be used.
1992	* @param paReq Pointer to array of iSCSI request sections.
1993	* @param cnReq Number of valid iSCSI request sections in the array.
1994	* @param uFlags Flags controlling the exact send semantics.
1995	*/
1996	static int iscsiSendPDU(PISCSIIMAGE pImage, PISCSIREQ paReq, uint32_t cnReq,
1997	uint32_t uFlags)
1998	{
1999	int rc = VINF_SUCCESS;
2000	/** @todo return VERR_VD_ISCSI_INVALID_STATE in the appropriate situations,
2001	* needs cleaning up of timeout/disconnect handling a bit, as otherwise
2002	* too many incorrect errors are signalled. */
2003	Assert(cnReq >= 1);
2004	Assert(paReq[0].cbSeg >= ISCSI_BHS_SIZE);
2005
2006	for (uint32_t i = 0; i < pImage->cISCSIRetries; i++)
2007	{
2008	rc = iscsiTransportWrite(pImage, paReq, cnReq);
2009	if (RT_SUCCESS(rc))
2010	break;
2011	if ( (uFlags & ISCSIPDU_NO_REATTACH)
2012	\|\| (rc != VERR_BROKEN_PIPE && rc != VERR_NET_CONNECTION_REFUSED))
2013	break;
2014	/* No point in reestablishing the connection for a logout */
2015	if (pImage->state == ISCSISTATE_IN_LOGOUT)
2016	break;
2017	RTThreadSleep(500);
2018	if (pImage->state != ISCSISTATE_IN_LOGIN)
2019	{
2020	/* Attempt to re-login when a connection fails, but only when not
2021	* currently logging in. */
2022	rc = iscsiAttach(pImage);
2023	if (RT_FAILURE(rc))
2024	break;
2025	}
2026	}
2027	return rc;
2028	}
2029
2030
2031	/**
2032	* Wait for an iSCSI response with a matching Initiator Target Tag. The response is
2033	* split into several segments, as requested by the caller-provided buffer specification.
2034	* Remember that the response can be split into several PDUs by the sender, so make
2035	* sure that all parts are collected and processed appropriately by the caller.
2036	*
2037	* @returns VBOX status
2038	* @param pImage The iSCSI connection state to be used.
2039	* @param paRes Pointer to array of iSCSI response sections.
2040	* @param cnRes Number of valid iSCSI response sections in the array.
2041	*/
2042	static int iscsiRecvPDU(PISCSIIMAGE pImage, uint32_t itt, PISCSIRES paRes, uint32_t cnRes)
2043	{
2044	int rc = VINF_SUCCESS;
2045	ISCSIRES aResBuf;
2046
2047	for (uint32_t i = 0; i < pImage->cISCSIRetries; i++)
2048	{
2049	aResBuf.pvSeg = pImage->pvRecvPDUBuf;
2050	aResBuf.cbSeg = pImage->cbRecvPDUBuf;
2051	rc = iscsiTransportRead(pImage, &aResBuf, 1);
2052	if (RT_FAILURE(rc))
2053	{
2054	if (rc == VERR_BROKEN_PIPE \|\| rc == VERR_NET_CONNECTION_REFUSED)
2055	{
2056	/* No point in reestablishing the connection for a logout */
2057	if (pImage->state == ISCSISTATE_IN_LOGOUT)
2058	break;
2059	/* Connection broken while waiting for a response - wait a while and
2060	* try to restart by re-sending the original request (if any).
2061	* This also handles the connection reestablishment (login etc.). */
2062	RTThreadSleep(500);
2063	if (pImage->state != ISCSISTATE_IN_LOGIN)
2064	{
2065	/* Attempt to re-login when a connection fails, but only when not
2066	* currently logging in. */
2067	rc = iscsiAttach(pImage);
2068	if (RT_FAILURE(rc))
2069	break;
2070	}
2071	if (pImage->paCurrReq != NULL)
2072	{
2073	rc = iscsiSendPDU(pImage, pImage->paCurrReq, pImage->cnCurrReq, ISCSIPDU_DEFAULT);
2074	if (RT_FAILURE(rc))
2075	break;
2076	}
2077	}
2078	else
2079	{
2080	/* Signal other errors (VERR_BUFFER_OVERFLOW etc.) to the caller. */
2081	break;
2082	}
2083	}
2084	else
2085	{
2086	ISCSIOPCODE cmd;
2087	const uint32_t pcvResSeg = (const uint32_t )aResBuf.pvSeg;
2088
2089	/* Check whether the received PDU is valid, and update the internal state of
2090	* the iSCSI connection/session. */
2091	rc = iscsiValidatePDU(&aResBuf, 1);
2092	if (RT_FAILURE(rc))
2093	continue;
2094	cmd = (ISCSIOPCODE)(RT_N2H_U32(pcvResSeg[0]) & ISCSIOP_MASK);
2095	switch (cmd)
2096	{
2097	case ISCSIOP_SCSI_RES:
2098	case ISCSIOP_SCSI_TASKMGMT_RES:
2099	case ISCSIOP_SCSI_DATA_IN:
2100	case ISCSIOP_R2T:
2101	case ISCSIOP_ASYN_MSG:
2102	case ISCSIOP_TEXT_RES:
2103	case ISCSIOP_LOGIN_RES:
2104	case ISCSIOP_LOGOUT_RES:
2105	case ISCSIOP_REJECT:
2106	case ISCSIOP_NOP_IN:
2107	if (serial_number_less(pImage->MaxCmdSN, RT_N2H_U32(pcvResSeg[8])))
2108	pImage->MaxCmdSN = RT_N2H_U32(pcvResSeg[8]);
2109	if (serial_number_less(pImage->ExpCmdSN, RT_N2H_U32(pcvResSeg[7])))
2110	pImage->ExpCmdSN = RT_N2H_U32(pcvResSeg[7]);
2111	break;
2112	default:
2113	rc = VERR_PARSE_ERROR;
2114	}
2115	if (RT_FAILURE(rc))
2116	continue;
2117	if ( !pImage->FirstRecvPDU
2118	&& (cmd != ISCSIOP_SCSI_DATA_IN \|\| (RT_N2H_U32(pcvResSeg[0]) & ISCSI_STATUS_BIT)))
2119	{
2120	if (pImage->ExpStatSN == RT_N2H_U32(pcvResSeg[6]))
2121	{
2122	/* StatSN counter is not advanced on R2T and on a target SN update NOP-In. */
2123	if ( (cmd != ISCSIOP_R2T)
2124	&& ((cmd != ISCSIOP_NOP_IN) \|\| (RT_N2H_U32(pcvResSeg[4]) != ISCSI_TASK_TAG_RSVD)))
2125	pImage->ExpStatSN++;
2126	}
2127	else
2128	{
2129	rc = VERR_PARSE_ERROR;
2130	continue;
2131	}
2132	}
2133	/* Finally check whether the received PDU matches what the caller wants. */
2134	if ( itt == pcvResSeg[4]
2135	&& itt != ISCSI_TASK_TAG_RSVD)
2136	{
2137	/* Copy received PDU (one segment) to caller-provided buffers. */
2138	uint32_t j;
2139	size_t cbSeg;
2140	const uint8_t *pSrc;
2141
2142	pSrc = (const uint8_t *)aResBuf.pvSeg;
2143	cbSeg = aResBuf.cbSeg;
2144	for (j = 0; j < cnRes; j++)
2145	{
2146	if (cbSeg > paRes[j].cbSeg)
2147	{
2148	memcpy(paRes[j].pvSeg, pSrc, paRes[j].cbSeg);
2149	pSrc += paRes[j].cbSeg;
2150	cbSeg -= paRes[j].cbSeg;
2151	}
2152	else
2153	{
2154	memcpy(paRes[j].pvSeg, pSrc, cbSeg);
2155	paRes[j].cbSeg = cbSeg;
2156	cbSeg = 0;
2157	break;
2158	}
2159	}
2160	if (cbSeg != 0)
2161	{
2162	rc = VERR_BUFFER_OVERFLOW;
2163	break;
2164	}
2165	for (j++; j < cnRes; j++)
2166	paRes[j].cbSeg = 0;
2167	break;
2168	}
2169	else if ( cmd == ISCSIOP_NOP_IN
2170	&& RT_N2H_U32(pcvResSeg[5]) != ISCSI_TASK_TAG_RSVD)
2171	{
2172	uint32_t cnISCSIReq;
2173	ISCSIREQ aISCSIReq[4];
2174	uint32_t aReqBHS[12];
2175
2176	aReqBHS[0] = RT_H2N_U32(ISCSI_IMMEDIATE_DELIVERY_BIT \| ISCSI_FINAL_BIT \| ISCSIOP_NOP_OUT);
2177	aReqBHS[1] = RT_H2N_U32(0); /* TotalAHSLength=0,DataSementLength=0 */
2178	aReqBHS[2] = pcvResSeg[2]; /* copy LUN from NOP-In */
2179	aReqBHS[3] = pcvResSeg[3]; /* copy LUN from NOP-In */
2180	aReqBHS[4] = RT_H2N_U32(ISCSI_TASK_TAG_RSVD); /* ITT, reply */
2181	aReqBHS[5] = pcvResSeg[5]; /* copy TTT from NOP-In */
2182	aReqBHS[6] = RT_H2N_U32(pImage->CmdSN);
2183	aReqBHS[7] = RT_H2N_U32(pImage->ExpStatSN);
2184	aReqBHS[8] = 0; /* reserved */
2185	aReqBHS[9] = 0; /* reserved */
2186	aReqBHS[10] = 0; /* reserved */
2187	aReqBHS[11] = 0; /* reserved */
2188
2189	cnISCSIReq = 0;
2190	aISCSIReq[cnISCSIReq].pcvSeg = aReqBHS;
2191	aISCSIReq[cnISCSIReq].cbSeg = sizeof(aReqBHS);
2192	cnISCSIReq++;
2193
2194	iscsiSendPDU(pImage, aISCSIReq, cnISCSIReq, ISCSIPDU_NO_REATTACH);
2195	/* Break if the caller wanted to process the NOP-in only. */
2196	if (itt == ISCSI_TASK_TAG_RSVD)
2197	break;
2198	}
2199	}
2200	}
2201	return rc;
2202	}
2203
2204
2205	/**
2206	* Reset the PDU buffer
2207	*
2208	* @param pImage The iSCSI connection state to be used.
2209	*/
2210	static void iscsiRecvPDUReset(PISCSIIMAGE pImage)
2211	{
2212	pImage->cbRecvPDUResidual = ISCSI_BHS_SIZE;
2213	pImage->fRecvPDUBHS = true;
2214	pImage->pbRecvPDUBufCur = (uint8_t *)pImage->pvRecvPDUBuf;
2215	}
2216
2217	static void iscsiPDUTxAdd(PISCSIIMAGE pImage, PISCSIPDUTX pIScsiPDUTx, bool fFront)
2218	{
2219	if (!fFront)
2220	{
2221	/* Link the PDU at the tail of the list. */
2222	if (!pImage->pIScsiPDUTxHead)
2223	pImage->pIScsiPDUTxHead = pIScsiPDUTx;
2224	else
2225	pImage->pIScsiPDUTxTail->pNext = pIScsiPDUTx;
2226	pImage->pIScsiPDUTxTail = pIScsiPDUTx;
2227	}
2228	else
2229	{
2230	/* Link PDU to at the front of the list. */
2231	pIScsiPDUTx->pNext = pImage->pIScsiPDUTxHead;
2232	pImage->pIScsiPDUTxHead = pIScsiPDUTx;
2233	if (!pImage->pIScsiPDUTxTail)
2234	pImage->pIScsiPDUTxTail = pIScsiPDUTx;
2235	}
2236	}
2237
2238	/**
2239	* Receives a PDU in a non blocking way.
2240	*
2241	* @returns VBOX status code.
2242	* @param pImage The iSCSI connection state to be used.
2243	*/
2244	static int iscsiRecvPDUAsync(PISCSIIMAGE pImage)
2245	{
2246	size_t cbActuallyRead = 0;
2247	int rc = VINF_SUCCESS;
2248
2249	LogFlowFunc(("pImage=%#p\n", pImage));
2250
2251	/* Check if we are in the middle of a PDU receive. */
2252	if (pImage->cbRecvPDUResidual == 0)
2253	{
2254	/*
2255	* We are receiving a new PDU, don't read more than the BHS initially
2256	* until we know the real size of the PDU.
2257	*/
2258	iscsiRecvPDUReset(pImage);
2259	LogFlow(("Receiving new PDU\n"));
2260	}
2261
2262	rc = pImage->pInterfaceNetCallbacks->pfnReadNB(pImage->Socket, pImage->pbRecvPDUBufCur,
2263	pImage->cbRecvPDUResidual, &cbActuallyRead);
2264	if (RT_SUCCESS(rc) && cbActuallyRead == 0)
2265	rc = VERR_BROKEN_PIPE;
2266
2267	if (RT_SUCCESS(rc))
2268	{
2269	LogFlow(("Received %zu bytes\n", cbActuallyRead));
2270	pImage->cbRecvPDUResidual -= cbActuallyRead;
2271	pImage->pbRecvPDUBufCur += cbActuallyRead;
2272
2273	/* Check if we received everything we wanted. */
2274	if ( !pImage->cbRecvPDUResidual
2275	&& pImage->fRecvPDUBHS)
2276	{
2277	size_t cbAHSLength, cbDataLength;
2278
2279	/* If we were reading the BHS first get the actual PDU size now. */
2280	uint32_t word1 = RT_N2H_U32(((uint32_t *)(pImage->pvRecvPDUBuf))[1]);
2281	cbAHSLength = (word1 & 0xff000000) >> 24;
2282	cbAHSLength = ((cbAHSLength - 1) \| 3) + 1; /* Add padding. */
2283	cbDataLength = word1 & 0x00ffffff;
2284	cbDataLength = ((cbDataLength - 1) \| 3) + 1; /* Add padding. */
2285	pImage->cbRecvPDUResidual = cbAHSLength + cbDataLength;
2286	pImage->fRecvPDUBHS = false; /* Start receiving the rest of the PDU. */
2287	}
2288
2289	if (!pImage->cbRecvPDUResidual)
2290	{
2291	/* We received the complete PDU with or without any payload now. */
2292	LogFlow(("Received complete PDU\n"));
2293	ISCSIRES aResBuf;
2294	aResBuf.pvSeg = pImage->pvRecvPDUBuf;
2295	aResBuf.cbSeg = pImage->cbRecvPDUBuf;
2296	rc = iscsiRecvPDUProcess(pImage, &aResBuf, 1);
2297	}
2298	}
2299	else
2300	LogFlowFunc(("Reading from the socket returned with rc=%Rrc\n", rc));
2301
2302	return rc;
2303	}
2304
2305	static int iscsiSendPDUAsync(PISCSIIMAGE pImage)
2306	{
2307	size_t cbSent = 0;
2308	int rc = VINF_SUCCESS;
2309
2310	LogFlowFunc(("pImage=%#p\n", pImage));
2311
2312	do
2313	{
2314	/*
2315	* If there is no PDU active, get the first one from the list.
2316	* Check that we are allowed to transfer the PDU by comparing the
2317	* command sequence number and the maximum sequence number allowed by the target.
2318	*/
2319	if (!pImage->pIScsiPDUTxCur)
2320	{
2321	if ( !pImage->pIScsiPDUTxHead
2322	\|\| serial_number_greater(pImage->pIScsiPDUTxHead->CmdSN, pImage->MaxCmdSN))
2323	break;
2324
2325	pImage->pIScsiPDUTxCur = pImage->pIScsiPDUTxHead;
2326	pImage->pIScsiPDUTxHead = pImage->pIScsiPDUTxCur->pNext;
2327	if (!pImage->pIScsiPDUTxHead)
2328	pImage->pIScsiPDUTxTail = NULL;
2329	}
2330
2331	/* Send as much as we can. */
2332	rc = pImage->pInterfaceNetCallbacks->pfnSgWriteNB(pImage->Socket, &pImage->pIScsiPDUTxCur->SgBuf, &cbSent);
2333	LogFlow(("SgWriteNB returned rc=%Rrc cbSent=%zu\n", rc, cbSent));
2334	if (RT_SUCCESS(rc))
2335	{
2336	LogFlow(("Sent %zu bytes for PDU %#p\n", cbSent, pImage->pIScsiPDUTxCur));
2337	pImage->pIScsiPDUTxCur->cbSgLeft -= cbSent;
2338	RTSgBufAdvance(&pImage->pIScsiPDUTxCur->SgBuf, cbSent);
2339	if (!pImage->pIScsiPDUTxCur->cbSgLeft)
2340	{
2341	/* PDU completed, free it and place the command on the waiting for response list. */
2342	if (pImage->pIScsiPDUTxCur->pIScsiCmd)
2343	{
2344	LogFlow(("Sent complete PDU, placing on waiting list\n"));
2345	iscsiCmdInsert(pImage, pImage->pIScsiPDUTxCur->pIScsiCmd);
2346	}
2347	RTMemFree(pImage->pIScsiPDUTxCur);
2348	pImage->pIScsiPDUTxCur = NULL;
2349	}
2350	}
2351	} while ( RT_SUCCESS(rc)
2352	&& !pImage->pIScsiPDUTxCur);
2353
2354	if (rc == VERR_TRY_AGAIN)
2355	rc = VINF_SUCCESS;
2356
2357	/* Add the write poll flag if we still have something to send, clear it otherwise. */
2358	if (pImage->pIScsiPDUTxCur)
2359	pImage->fPollEvents \|= VD_INTERFACETCPNET_EVT_WRITE;
2360	else
2361	pImage->fPollEvents &= ~VD_INTERFACETCPNET_EVT_WRITE;
2362
2363	LogFlowFunc(("rc=%Rrc pIScsiPDUTxCur=%#p\n", rc, pImage->pIScsiPDUTxCur));
2364	return rc;
2365	}
2366
2367	/**
2368	* Process a received PDU.
2369	*
2370	* @return VBOX status code.
2371	* @param pImage The iSCSI connection state to be used.
2372	* @param paRes Pointer to the array of iSCSI response sections.
2373	* @param cnRes Number of valid iSCSI response sections in the array.
2374	*/
2375	static int iscsiRecvPDUProcess(PISCSIIMAGE pImage, PISCSIRES paRes, uint32_t cnRes)
2376	{
2377	int rc = VINF_SUCCESS;
2378
2379	LogFlowFunc(("pImage=%#p paRes=%#p cnRes=%u\n", pImage, paRes, cnRes));
2380
2381	/* Validate the PDU first. */
2382	rc = iscsiValidatePDU(paRes, cnRes);
2383	if (RT_SUCCESS(rc))
2384	{
2385	ISCSIOPCODE cmd;
2386	const uint32_t pcvResSeg = (const uint32_t )paRes[0].pvSeg;
2387
2388	Assert(paRes[0].cbSeg > 9 * sizeof(uint32_t));
2389
2390	do
2391	{
2392	cmd = (ISCSIOPCODE)(RT_N2H_U32(pcvResSeg[0]) & ISCSIOP_MASK);
2393	switch (cmd)
2394	{
2395	case ISCSIOP_SCSI_RES:
2396	case ISCSIOP_SCSI_TASKMGMT_RES:
2397	case ISCSIOP_SCSI_DATA_IN:
2398	case ISCSIOP_R2T:
2399	case ISCSIOP_ASYN_MSG:
2400	case ISCSIOP_TEXT_RES:
2401	case ISCSIOP_LOGIN_RES:
2402	case ISCSIOP_LOGOUT_RES:
2403	case ISCSIOP_REJECT:
2404	case ISCSIOP_NOP_IN:
2405	if (serial_number_less(pImage->MaxCmdSN, RT_N2H_U32(pcvResSeg[8])))
2406	pImage->MaxCmdSN = RT_N2H_U32(pcvResSeg[8]);
2407	if (serial_number_less(pImage->ExpCmdSN, RT_N2H_U32(pcvResSeg[7])))
2408	pImage->ExpCmdSN = RT_N2H_U32(pcvResSeg[7]);
2409	break;
2410	default:
2411	rc = VERR_PARSE_ERROR;
2412	}
2413
2414	if (RT_FAILURE(rc))
2415	break;
2416
2417	if ( !pImage->FirstRecvPDU
2418	&& (cmd != ISCSIOP_SCSI_DATA_IN \|\| (RT_N2H_U32(pcvResSeg[0]) & ISCSI_STATUS_BIT)))
2419	{
2420	if (pImage->ExpStatSN == RT_N2H_U32(pcvResSeg[6]))
2421	{
2422	/* StatSN counter is not advanced on R2T and on a target SN update NOP-In. */
2423	if ( (cmd != ISCSIOP_R2T)
2424	&& ((cmd != ISCSIOP_NOP_IN) \|\| (RT_N2H_U32(pcvResSeg[4]) != ISCSI_TASK_TAG_RSVD)))
2425	pImage->ExpStatSN++;
2426	}
2427	else
2428	{
2429	rc = VERR_PARSE_ERROR;
2430	break;
2431	}
2432	}
2433
2434	if (pcvResSeg[4] != ISCSI_TASK_TAG_RSVD)
2435	{
2436	/*
2437	* This is a response from the target for a request from the initiator.
2438	* Get the request and update its state.
2439	*/
2440	rc = iscsiRecvPDUUpdateRequest(pImage, paRes, cnRes);
2441	/* Try to send more PDUs now that we updated the MaxCmdSN field */
2442	if ( RT_SUCCESS(rc)
2443	&& !pImage->pIScsiPDUTxCur)
2444	rc = iscsiSendPDUAsync(pImage);
2445	}
2446	else
2447	{
2448	/* This is a target initiated request (we handle only NOP-In request at the moment). */
2449	if ( cmd == ISCSIOP_NOP_IN
2450	&& RT_N2H_U32(pcvResSeg[5]) != ISCSI_TASK_TAG_RSVD)
2451	{
2452	PISCSIPDUTX pIScsiPDUTx;
2453	uint32_t cnISCSIReq;
2454	uint32_t *paReqBHS;
2455
2456	LogFlowFunc(("Sending NOP-Out\n"));
2457
2458	/* Allocate a new PDU initialize it and put onto the waiting list. */
2459	pIScsiPDUTx = (PISCSIPDUTX)RTMemAllocZ(sizeof(ISCSIPDUTX));
2460	if (!pIScsiPDUTx)
2461	{
2462	rc = VERR_NO_MEMORY;
2463	break;
2464	}
2465	paReqBHS = &pIScsiPDUTx->aBHS[0];
2466	paReqBHS[0] = RT_H2N_U32(ISCSI_IMMEDIATE_DELIVERY_BIT \| ISCSI_FINAL_BIT \| ISCSIOP_NOP_OUT);
2467	paReqBHS[1] = RT_H2N_U32(0); /* TotalAHSLength=0,DataSementLength=0 */
2468	paReqBHS[2] = pcvResSeg[2]; /* copy LUN from NOP-In */
2469	paReqBHS[3] = pcvResSeg[3]; /* copy LUN from NOP-In */
2470	paReqBHS[4] = RT_H2N_U32(ISCSI_TASK_TAG_RSVD); /* ITT, reply */
2471	paReqBHS[5] = pcvResSeg[5]; /* copy TTT from NOP-In */
2472	paReqBHS[6] = RT_H2N_U32(pImage->CmdSN);
2473	paReqBHS[7] = RT_H2N_U32(pImage->ExpStatSN);
2474	paReqBHS[8] = 0; /* reserved */
2475	paReqBHS[9] = 0; /* reserved */
2476	paReqBHS[10] = 0; /* reserved */
2477	paReqBHS[11] = 0; /* reserved */
2478
2479	cnISCSIReq = 0;
2480	pIScsiPDUTx->aISCSIReq[cnISCSIReq].pvSeg = paReqBHS;
2481	pIScsiPDUTx->aISCSIReq[cnISCSIReq].cbSeg = sizeof(pIScsiPDUTx->aBHS);
2482	cnISCSIReq++;
2483	pIScsiPDUTx->cbSgLeft = sizeof(pIScsiPDUTx->aBHS);
2484	RTSgBufInit(&pIScsiPDUTx->SgBuf, pIScsiPDUTx->aISCSIReq, cnISCSIReq);
2485
2486	/* Link the PDU to the list. */
2487	iscsiPDUTxAdd(pImage, pIScsiPDUTx, false /* fFront */);
2488
2489	/* Start transfer of a PDU if there is no one active at the moment. */
2490	if (!pImage->pIScsiPDUTxCur)
2491	rc = iscsiSendPDUAsync(pImage);
2492	}
2493	}
2494	} while (0);
2495	}
2496
2497	return rc;
2498	}
2499
2500	/**
2501	* Check the static (not dependent on the connection/session state) validity of an iSCSI response PDU.
2502	*
2503	* @returns VBOX status
2504	* @param paRes Pointer to array of iSCSI response sections.
2505	* @param cnRes Number of valid iSCSI response sections in the array.
2506	*/
2507	static int iscsiValidatePDU(PISCSIRES paRes, uint32_t cnRes)
2508	{
2509	const uint32_t *pcrgResBHS;
2510	uint32_t hw0;
2511	Assert(cnRes >= 1);
2512	Assert(paRes[0].cbSeg >= ISCSI_BHS_SIZE);
2513
2514	LogFlowFunc(("paRes=%#p cnRes=%u\n", paRes, cnRes));
2515
2516	pcrgResBHS = (const uint32_t *)(paRes[0].pvSeg);
2517	hw0 = RT_N2H_U32(pcrgResBHS[0]);
2518	switch (hw0 & ISCSIOP_MASK)
2519	{
2520	case ISCSIOP_NOP_IN:
2521	/* NOP-In responses must not be split into several PDUs nor it may contain
2522	* ping data for target-initiated pings nor may both task tags be valid task tags. */
2523	if ( (hw0 & ISCSI_FINAL_BIT) == 0
2524	\|\| ( RT_N2H_U32(pcrgResBHS[4]) == ISCSI_TASK_TAG_RSVD
2525	&& RT_N2H_U32(pcrgResBHS[1]) != 0)
2526	\|\| ( RT_N2H_U32(pcrgResBHS[4]) != ISCSI_TASK_TAG_RSVD
2527	&& RT_N2H_U32(pcrgResBHS[5]) != ISCSI_TASK_TAG_RSVD))
2528	return VERR_PARSE_ERROR;
2529	break;
2530	case ISCSIOP_SCSI_RES:
2531	/* SCSI responses must not be split into several PDUs nor must the residual
2532	* bits be contradicting each other nor may the residual bits be set for PDUs
2533	* containing anything else but a completed command response. Underflow
2534	* is no reason for declaring a PDU as invalid, as the target may choose
2535	* to return less data than we assume to get. */
2536	if ( (hw0 & ISCSI_FINAL_BIT) == 0
2537	\|\| ((hw0 & ISCSI_BI_READ_RESIDUAL_OVFL_BIT) && (hw0 & ISCSI_BI_READ_RESIDUAL_UNFL_BIT))
2538	\|\| ((hw0 & ISCSI_RESIDUAL_OVFL_BIT) && (hw0 & ISCSI_RESIDUAL_UNFL_BIT))
2539	\|\| ( ((hw0 & ISCSI_SCSI_RESPONSE_MASK) == 0)
2540	&& ((hw0 & ISCSI_SCSI_STATUS_MASK) == SCSI_STATUS_OK)
2541	&& (hw0 & ( ISCSI_BI_READ_RESIDUAL_OVFL_BIT \| ISCSI_BI_READ_RESIDUAL_UNFL_BIT
2542	\| ISCSI_RESIDUAL_OVFL_BIT))))
2543	return VERR_PARSE_ERROR;
2544	break;
2545	case ISCSIOP_LOGIN_RES:
2546	/* Login responses must not contain contradicting transit and continue bits. */
2547	if ((hw0 & ISCSI_CONTINUE_BIT) && ((hw0 & ISCSI_TRANSIT_BIT) != 0))
2548	return VERR_PARSE_ERROR;
2549	break;
2550	case ISCSIOP_TEXT_RES:
2551	/* Text responses must not contain contradicting final and continue bits nor
2552	* may the final bit be set for PDUs containing a target transfer tag other than
2553	* the reserved transfer tag (and vice versa). */
2554	if ( (((hw0 & ISCSI_CONTINUE_BIT) && (hw0 & ISCSI_FINAL_BIT) != 0))
2555	\|\| (((hw0 & ISCSI_FINAL_BIT) && (RT_N2H_U32(pcrgResBHS[5]) != ISCSI_TASK_TAG_RSVD)))
2556	\|\| (((hw0 & ISCSI_FINAL_BIT) == 0) && (RT_N2H_U32(pcrgResBHS[5]) == ISCSI_TASK_TAG_RSVD)))
2557	return VERR_PARSE_ERROR;
2558	break;
2559	case ISCSIOP_SCSI_DATA_IN:
2560	/* SCSI Data-in responses must not contain contradicting residual bits when
2561	* status bit is set. */
2562	if ((hw0 & ISCSI_STATUS_BIT) && (hw0 & ISCSI_RESIDUAL_OVFL_BIT) && (hw0 & ISCSI_RESIDUAL_UNFL_BIT))
2563	return VERR_PARSE_ERROR;
2564	break;
2565	case ISCSIOP_LOGOUT_RES:
2566	/* Logout responses must not have the final bit unset and may not contain any
2567	* data or additional header segments. */
2568	if ( ((hw0 & ISCSI_FINAL_BIT) == 0)
2569	\|\| (RT_N2H_U32(pcrgResBHS[1]) != 0))
2570	return VERR_PARSE_ERROR;
2571	break;
2572	case ISCSIOP_ASYN_MSG:
2573	/* Asynchronous Messages must not have the final bit unset and may not contain
2574	* an initiator task tag. */
2575	if ( ((hw0 & ISCSI_FINAL_BIT) == 0)
2576	\|\| (RT_N2H_U32(pcrgResBHS[4]) != ISCSI_TASK_TAG_RSVD))
2577	return VERR_PARSE_ERROR;
2578	break;
2579	case ISCSIOP_SCSI_TASKMGMT_RES:
2580	case ISCSIOP_R2T:
2581	case ISCSIOP_REJECT:
2582	default:
2583	/* Do some logging, ignore PDU. */
2584	LogFlowFunc(("ignore unhandled PDU, first word %#08x\n", RT_N2H_U32(pcrgResBHS[0])));
2585	return VERR_PARSE_ERROR;
2586	}
2587	/* A target must not send PDUs with MaxCmdSN less than ExpCmdSN-1. */
2588
2589	if (serial_number_less(RT_N2H_U32(pcrgResBHS[8]), RT_N2H_U32(pcrgResBHS[7])-1))
2590	return VERR_PARSE_ERROR;
2591
2592	return VINF_SUCCESS;
2593	}
2594
2595
2596	/**
2597	* Prepares a PDU to transfer for the given command and adds it to the list.
2598	*/
2599	static int iscsiPDUTxPrepare(PISCSIIMAGE pImage, PISCSICMD pIScsiCmd)
2600	{
2601	int rc = VINF_SUCCESS;
2602	uint32_t *paReqBHS;
2603	size_t cbData = 0;
2604	size_t cbSegs = 0;
2605	PSCSIREQ pScsiReq;
2606	PISCSIPDUTX pIScsiPDU = NULL;
2607
2608	LogFlowFunc(("pImage=%#p pIScsiCmd=%#p\n", pImage, pIScsiCmd));
2609
2610	Assert(pIScsiCmd->enmCmdType == ISCSICMDTYPE_REQ);
2611
2612	pIScsiCmd->Itt = iscsiNewITT(pImage);
2613	pScsiReq = pIScsiCmd->CmdType.ScsiReq.pScsiReq;
2614
2615	if (pScsiReq->cT2ISegs)
2616	RTSgBufInit(&pScsiReq->SgBufT2I, pScsiReq->paT2ISegs, pScsiReq->cT2ISegs);
2617
2618	/*
2619	* Allocate twice as much entries as required for padding (worst case).
2620	* The additional segment is for the BHS.
2621	*/
2622	size_t cI2TSegs = 2*(pScsiReq->cI2TSegs + 1);
2623	pIScsiPDU = (PISCSIPDUTX)RTMemAllocZ(RT_OFFSETOF(ISCSIPDUTX, aISCSIReq[cI2TSegs]));
2624	if (!pIScsiPDU)
2625	return VERR_NO_MEMORY;
2626
2627	pIScsiPDU->pIScsiCmd = pIScsiCmd;
2628
2629	if (pScsiReq->enmXfer == SCSIXFER_FROM_TARGET)
2630	cbData = (uint32_t)pScsiReq->cbT2IData;
2631	else
2632	cbData = (uint32_t)pScsiReq->cbI2TData;
2633
2634	paReqBHS = pIScsiPDU->aBHS;
2635
2636	/* Setup the BHS. */
2637	paReqBHS[0] = RT_H2N_U32( ISCSI_FINAL_BIT \| ISCSI_TASK_ATTR_ORDERED \| ISCSIOP_SCSI_CMD
2638	\| (pScsiReq->enmXfer << 21)); /* I=0,F=1,Attr=Ordered */
2639	paReqBHS[1] = RT_H2N_U32(0x00000000 \| ((uint32_t)pScsiReq->cbI2TData & 0xffffff)); /* TotalAHSLength=0 */
2640	paReqBHS[2] = RT_H2N_U32(pImage->LUN >> 32);
2641	paReqBHS[3] = RT_H2N_U32(pImage->LUN & 0xffffffff);
2642	paReqBHS[4] = pIScsiCmd->Itt;
2643	paReqBHS[5] = RT_H2N_U32(cbData);
2644	paReqBHS[6] = RT_H2N_U32(pImage->CmdSN);
2645	paReqBHS[7] = RT_H2N_U32(pImage->ExpStatSN);
2646	memcpy(paReqBHS + 8, pScsiReq->pvCDB, pScsiReq->cbCDB);
2647
2648	pIScsiPDU->CmdSN = pImage->CmdSN;
2649	pImage->CmdSN++;
2650
2651	/* Setup the S/G buffers. */
2652	uint32_t cnISCSIReq = 0;
2653	pIScsiPDU->aISCSIReq[cnISCSIReq].cbSeg = sizeof(pIScsiPDU->aBHS);
2654	pIScsiPDU->aISCSIReq[cnISCSIReq].pvSeg = pIScsiPDU->aBHS;
2655	cnISCSIReq++;
2656	cbSegs = sizeof(pIScsiPDU->aBHS);
2657	/* Padding is not necessary for the BHS. */
2658
2659	if (pScsiReq->cbI2TData)
2660	{
2661	for (unsigned cSeg = 0; cSeg < pScsiReq->cI2TSegs; cSeg++)
2662	{
2663	Assert(cnISCSIReq < cI2TSegs);
2664	pIScsiPDU->aISCSIReq[cnISCSIReq].cbSeg = pScsiReq->paI2TSegs[cSeg].cbSeg;
2665	pIScsiPDU->aISCSIReq[cnISCSIReq].pvSeg = pScsiReq->paI2TSegs[cSeg].pvSeg;
2666	cbSegs += pScsiReq->paI2TSegs[cSeg].cbSeg;
2667	cnISCSIReq++;
2668
2669	/* Add padding if necessary. */
2670	if (pScsiReq->paI2TSegs[cSeg].cbSeg & 3)
2671	{
2672	Assert(cnISCSIReq < cI2TSegs);
2673	pIScsiPDU->aISCSIReq[cnISCSIReq].pvSeg = &pImage->aPadding[0];
2674	pIScsiPDU->aISCSIReq[cnISCSIReq].cbSeg = 4 - (pScsiReq->paI2TSegs[cSeg].cbSeg & 3);
2675	cbSegs += pIScsiPDU->aISCSIReq[cnISCSIReq].cbSeg;
2676	cnISCSIReq++;
2677	}
2678	}
2679	}
2680
2681	pIScsiPDU->cISCSIReq = cnISCSIReq;
2682	pIScsiPDU->cbSgLeft = cbSegs;
2683	RTSgBufInit(&pIScsiPDU->SgBuf, pIScsiPDU->aISCSIReq, cnISCSIReq);
2684
2685	/* Link the PDU to the list. */
2686	iscsiPDUTxAdd(pImage, pIScsiPDU, false /* fFront */);
2687
2688	/* Start transfer of a PDU if there is no one active at the moment. */
2689	if (!pImage->pIScsiPDUTxCur)
2690	rc = iscsiSendPDUAsync(pImage);
2691
2692	return rc;
2693	}
2694
2695
2696	/**
2697	* Updates the state of a request from the PDU we received.
2698	*
2699	* @return VBox status code.
2700	* @param pImage iSCSI connection state to use.
2701	* @param paRes Pointer to array of iSCSI response sections.
2702	* @param cnRes Number of valid iSCSI response sections in the array.
2703	*/
2704	static int iscsiRecvPDUUpdateRequest(PISCSIIMAGE pImage, PISCSIRES paRes, uint32_t cnRes)
2705	{
2706	int rc = VINF_SUCCESS;
2707	PISCSICMD pIScsiCmd;
2708	uint32_t *paResBHS;
2709
2710	LogFlowFunc(("pImage=%#p paRes=%#p cnRes=%u\n", pImage, paRes, cnRes));
2711
2712	Assert(cnRes == 1);
2713	Assert(paRes[0].cbSeg >= ISCSI_BHS_SIZE);
2714
2715	paResBHS = (uint32_t *)paRes[0].pvSeg;
2716
2717	pIScsiCmd = iscsiCmdGetFromItt(pImage, paResBHS[4]);
2718
2719	if (pIScsiCmd)
2720	{
2721	bool final = false;
2722	PSCSIREQ pScsiReq;
2723
2724	LogFlow(("Found SCSI command %#p for Itt=%#u\n", pIScsiCmd, paResBHS[4]));
2725
2726	Assert(pIScsiCmd->enmCmdType == ISCSICMDTYPE_REQ);
2727	pScsiReq = pIScsiCmd->CmdType.ScsiReq.pScsiReq;
2728
2729	final = !!(RT_N2H_U32(paResBHS[0]) & ISCSI_FINAL_BIT);
2730	ISCSIOPCODE cmd = (ISCSIOPCODE)(RT_N2H_U32(paResBHS[0]) & ISCSIOP_MASK);
2731	if (cmd == ISCSIOP_SCSI_RES)
2732	{
2733	/* This is the final PDU which delivers the status (and may be omitted if
2734	* the last Data-In PDU included successful completion status). Note
2735	* that ExpStatSN has been bumped already in iscsiRecvPDU. */
2736	if (!final \|\| ((RT_N2H_U32(paResBHS[0]) & 0x0000ff00) != 0) \|\| (RT_N2H_U32(paResBHS[6]) != pImage->ExpStatSN - 1))
2737	{
2738	/* SCSI Response in the wrong place or with a (target) failure. */
2739	LogFlow(("Wrong ExpStatSN value in PDU\n"));
2740	rc = VERR_PARSE_ERROR;
2741	}
2742	else
2743	{
2744	pScsiReq->status = RT_N2H_U32(paResBHS[0]) & 0x000000ff;
2745	size_t cbData = RT_N2H_U32(paResBHS[1]) & 0x00ffffff;
2746	void pvSense = (uint8_t )paRes[0].pvSeg + ISCSI_BHS_SIZE;
2747
2748	if (cbData >= 2)
2749	{
2750	uint32_t cbStat = RT_N2H_U32(((uint32_t *)pvSense)[0]) >> 16;
2751	if (cbStat + 2 > cbData)
2752	{
2753	rc = VERR_BUFFER_OVERFLOW;
2754	}
2755	else
2756	{
2757	/* Truncate sense data if it doesn't fit into the buffer. */
2758	pScsiReq->cbSense = RT_MIN(cbStat, pScsiReq->cbSense);
2759	memcpy(pScsiReq->pvSense, (uint8_t *)pvSense + 2,
2760	RT_MIN(paRes[0].cbSeg - ISCSI_BHS_SIZE - 2, pScsiReq->cbSense));
2761	}
2762	}
2763	else if (cbData == 1)
2764	rc = VERR_PARSE_ERROR;
2765	else
2766	pScsiReq->cbSense = 0;
2767	}
2768	iscsiCmdComplete(pImage, pIScsiCmd, rc);
2769	}
2770	else if (cmd == ISCSIOP_SCSI_DATA_IN)
2771	{
2772	/* A Data-In PDU carries some data that needs to be added to the received
2773	* data in response to the command. There may be both partial and complete
2774	* Data-In PDUs, so collect data until the status is included or the status
2775	* is sent in a separate SCSI Result frame (see above). */
2776	size_t cbData = RT_N2H_U32(paResBHS[1]) & 0x00ffffff;
2777	void pvData = (uint8_t )paRes[0].pvSeg + ISCSI_BHS_SIZE;
2778
2779	if (final && cbData > pScsiReq->cbT2IData)
2780	{
2781	/* The received PDU is bigger than what we requested.
2782	* Must not happen under normal circumstances and is a target error. */
2783	rc = VERR_BUFFER_OVERFLOW;
2784	}
2785	else
2786	{
2787	/* Copy data from the received PDU into the T2I segments. */
2788	size_t cbCopied = RTSgBufCopyFromBuf(&pScsiReq->SgBufT2I, pvData, cbData);
2789	Assert(cbCopied == cbData);
2790
2791	if (final && (RT_N2H_U32(paResBHS[0]) & ISCSI_STATUS_BIT) != 0)
2792	{
2793	pScsiReq->status = RT_N2H_U32(paResBHS[0]) & 0x000000ff;
2794	pScsiReq->cbSense = 0;
2795	iscsiCmdComplete(pImage, pIScsiCmd, VINF_SUCCESS);
2796	}
2797	}
2798	}
2799	else
2800	rc = VERR_PARSE_ERROR;
2801	}
2802
2803	/* Log any errors here but ignore the PDU. */
2804	if (RT_FAILURE(rc))
2805	{
2806	LogRel(("iSCSI: Received malformed PDU from target %s (rc=%Rrc), ignoring\n", pImage->pszTargetName, rc));
2807	rc = VINF_SUCCESS;
2808	}
2809
2810	return rc;
2811	}
2812
2813	/**
2814	* Appends a key-value pair to the buffer. Normal ASCII strings (cbValue == 0) and large binary values
2815	* of a given length (cbValue > 0) are directly supported. Other value types must be converted to ASCII
2816	* by the caller. Strings must be in UTF-8 encoding.
2817	*
2818	* @returns VBOX status
2819	* @param pbBuf Pointer to the key-value buffer.
2820	* @param cbBuf Length of the key-value buffer.
2821	* @param pcbBufCurr Currently used portion of the key-value buffer.
2822	* @param pszKey Pointer to a string containing the key.
2823	* @param pszValue Pointer to either a string containing the value or to a large binary value.
2824	* @param cbValue Length of the binary value if applicable.
2825	*/
2826	static int iscsiTextAddKeyValue(uint8_t pbBuf, size_t cbBuf, size_t pcbBufCurr, const char *pcszKey,
2827	const char *pcszValue, size_t cbValue)
2828	{
2829	size_t cbBufTmp = *pcbBufCurr;
2830	size_t cbKey = strlen(pcszKey);
2831	size_t cbValueEnc;
2832	uint8_t *pbCurr;
2833
2834	if (cbValue == 0)
2835	cbValueEnc = strlen(pcszValue);
2836	else
2837	cbValueEnc = cbValue * 2 + 2; /* 2 hex bytes per byte, 2 bytes prefix */
2838
2839	if (cbBuf < cbBufTmp + cbKey + 1 + cbValueEnc + 1)
2840	{
2841	/* Buffer would overflow, signal error. */
2842	return VERR_BUFFER_OVERFLOW;
2843	}
2844
2845	/*
2846	* Append a key=value pair (zero terminated string) to the end of the buffer.
2847	*/
2848	pbCurr = pbBuf + cbBufTmp;
2849	memcpy(pbCurr, pcszKey, cbKey);
2850	pbCurr += cbKey;
2851	*pbCurr++ = '=';
2852	if (cbValue == 0)
2853	{
2854	memcpy(pbCurr, pcszValue, cbValueEnc);
2855	pbCurr += cbValueEnc;
2856	}
2857	else
2858	{
2859	*pbCurr++ = '0';
2860	*pbCurr++ = 'x';
2861	for (uint32_t i = 0; i < cbValue; i++)
2862	{
2863	uint8_t b;
2864	b = pcszValue[i];
2865	*pbCurr++ = NUM_2_HEX(b >> 4);
2866	*pbCurr++ = NUM_2_HEX(b & 0xf);
2867	}
2868	}
2869	*pbCurr = '\0';
2870	*pcbBufCurr = cbBufTmp + cbKey + 1 + cbValueEnc + 1;
2871
2872	return VINF_SUCCESS;
2873	}
2874
2875
2876	/**
2877	* Retrieve the value for a given key from the key=value buffer.
2878	*
2879	* @returns VBOX status.
2880	* @param pbBuf Buffer containing key=value pairs.
2881	* @param cbBuf Length of buffer with key=value pairs.
2882	* @param pszKey Pointer to key for which to retrieve the value.
2883	* @param ppszValue Pointer to value string pointer.
2884	*/
2885	static int iscsiTextGetKeyValue(const uint8_t pbBuf, size_t cbBuf, const char pcszKey, const char **ppcszValue)
2886	{
2887	size_t cbKey = strlen(pcszKey);
2888
2889	while (cbBuf != 0)
2890	{
2891	size_t cbKeyValNull = strlen((const char *)pbBuf) + 1;
2892
2893	if (strncmp(pcszKey, (const char *)pbBuf, cbKey) == 0 && pbBuf[cbKey] == '=')
2894	{
2895	ppcszValue = (const char )(pbBuf + cbKey + 1);
2896	return VINF_SUCCESS;
2897	}
2898	pbBuf += cbKeyValNull;
2899	cbBuf -= cbKeyValNull;
2900	}
2901	return VERR_INVALID_NAME;
2902	}
2903
2904
2905	/**
2906	* Convert a long-binary value from a value string to the binary representation.
2907	*
2908	* @returns VBOX status
2909	* @param pszValue Pointer to a string containing the textual value representation.
2910	* @param pbValue Pointer to the value buffer for the binary value.
2911	* @param pcbValue In: length of value buffer, out: actual length of binary value.
2912	*/
2913	static int iscsiStrToBinary(const char pcszValue, uint8_t pbValue, size_t *pcbValue)
2914	{
2915	size_t cbValue = *pcbValue;
2916	char c1, c2, c3, c4;
2917	Assert(cbValue >= 1);
2918
2919	if (strlen(pcszValue) < 3)
2920	return VERR_PARSE_ERROR;
2921	if (*pcszValue++ != '0')
2922	return VERR_PARSE_ERROR;
2923	switch (*pcszValue++)
2924	{
2925	case 'x':
2926	case 'X':
2927	if (strlen(pcszValue) & 1)
2928	{
2929	c1 = *pcszValue++;
2930	*pbValue++ = HEX_2_NUM(c1);
2931	cbValue--;
2932	}
2933	while (*pcszValue != '\0')
2934	{
2935	if (cbValue == 0)
2936	return VERR_BUFFER_OVERFLOW;
2937	c1 = *pcszValue++;
2938	if ((c1 < '0' \|\| c1 > '9') && (c1 < 'a' \|\| c1 > 'f') && (c1 < 'A' \|\| c1 > 'F'))
2939	return VERR_PARSE_ERROR;
2940	c2 = *pcszValue++;
2941	if ((c2 < '0' \|\| c2 > '9') && (c2 < 'a' \|\| c2 > 'f') && (c2 < 'A' \|\| c2 > 'F'))
2942	return VERR_PARSE_ERROR;
2943	*pbValue++ = (HEX_2_NUM(c1) << 4) \| HEX_2_NUM(c2);
2944	cbValue--;
2945	}
2946	*pcbValue -= cbValue;
2947	break;
2948	case 'b':
2949	case 'B':
2950	if ((strlen(pcszValue) & 3) != 0)
2951	return VERR_PARSE_ERROR;
2952	while (*pcszValue != '\0')
2953	{
2954	uint32_t temp;
2955	if (cbValue == 0)
2956	return VERR_BUFFER_OVERFLOW;
2957	c1 = *pcszValue++;
2958	if ((c1 < 'A' \|\| c1 > 'Z') && (c1 < 'a' \|\| c1 >'z') && (c1 < '0' \|\| c1 > '9') && (c1 != '+') && (c1 != '/'))
2959	return VERR_PARSE_ERROR;
2960	c2 = *pcszValue++;
2961	if ((c2 < 'A' \|\| c2 > 'Z') && (c2 < 'a' \|\| c2 >'z') && (c2 < '0' \|\| c2 > '9') && (c2 != '+') && (c2 != '/'))
2962	return VERR_PARSE_ERROR;
2963	c3 = *pcszValue++;
2964	if ((c3 < 'A' \|\| c3 > 'Z') && (c3 < 'a' \|\| c3 >'z') && (c3 < '0' \|\| c3 > '9') && (c3 != '+') && (c3 != '/') && (c3 != '='))
2965	return VERR_PARSE_ERROR;
2966	c4 = *pcszValue++;
2967	if ( (c3 == '=' && c4 != '=')
2968	\|\| ((c4 < 'A' \|\| c4 > 'Z') && (c4 < 'a' \|\| c4 >'z') && (c4 < '0' \|\| c4 > '9') && (c4 != '+') && (c4 != '/') && (c4 != '=')))
2969	return VERR_PARSE_ERROR;
2970	temp = (B64_2_NUM(c1) << 18) \| (B64_2_NUM(c2) << 12);
2971	if (c3 == '=') {
2972	if (*pcszValue != '\0')
2973	return VERR_PARSE_ERROR;
2974	*pbValue++ = temp >> 16;
2975	cbValue--;
2976	} else {
2977	temp \|= B64_2_NUM(c3) << 6;
2978	if (c4 == '=') {
2979	if (*pcszValue != '\0')
2980	return VERR_PARSE_ERROR;
2981	if (cbValue < 2)
2982	return VERR_BUFFER_OVERFLOW;
2983	*pbValue++ = temp >> 16;
2984	*pbValue++ = (temp >> 8) & 0xff;
2985	cbValue -= 2;
2986	}
2987	else
2988	{
2989	temp \|= B64_2_NUM(c4);
2990	if (cbValue < 3)
2991	return VERR_BUFFER_OVERFLOW;
2992	*pbValue++ = temp >> 16;
2993	*pbValue++ = (temp >> 8) & 0xff;
2994	*pbValue++ = temp & 0xff;
2995	cbValue -= 3;
2996	}
2997	}
2998	}
2999	*pcbValue -= cbValue;
3000	break;
3001	default:
3002	return VERR_PARSE_ERROR;
3003	}
3004	return VINF_SUCCESS;
3005	}
3006
3007
3008	/**
3009	* Retrieve the relevant parameter values and update the initiator state.
3010	*
3011	* @returns VBOX status.
3012	* @param pImage Current iSCSI initiator state.
3013	* @param pbBuf Buffer containing key=value pairs.
3014	* @param cbBuf Length of buffer with key=value pairs.
3015	*/
3016	static int iscsiUpdateParameters(PISCSIIMAGE pImage, const uint8_t *pbBuf, size_t cbBuf)
3017	{
3018	int rc;
3019	const char *pcszMaxRecvDataSegmentLength = NULL;
3020	const char *pcszMaxBurstLength = NULL;
3021	const char *pcszFirstBurstLength = NULL;
3022	rc = iscsiTextGetKeyValue(pbBuf, cbBuf, "MaxRecvDataSegmentLength", &pcszMaxRecvDataSegmentLength);
3023	if (rc == VERR_INVALID_NAME)
3024	rc = VINF_SUCCESS;
3025	if (RT_FAILURE(rc))
3026	return VERR_PARSE_ERROR;
3027	rc = iscsiTextGetKeyValue(pbBuf, cbBuf, "MaxBurstLength", &pcszMaxBurstLength);
3028	if (rc == VERR_INVALID_NAME)
3029	rc = VINF_SUCCESS;
3030	if (RT_FAILURE(rc))
3031	return VERR_PARSE_ERROR;
3032	rc = iscsiTextGetKeyValue(pbBuf, cbBuf, "FirstBurstLength", &pcszFirstBurstLength);
3033	if (rc == VERR_INVALID_NAME)
3034	rc = VINF_SUCCESS;
3035	if (RT_FAILURE(rc))
3036	return VERR_PARSE_ERROR;
3037	if (pcszMaxRecvDataSegmentLength)
3038	{
3039	uint32_t cb = pImage->cbSendDataLength;
3040	rc = RTStrToUInt32Full(pcszMaxRecvDataSegmentLength, 0, &cb);
3041	AssertRC(rc);
3042	pImage->cbSendDataLength = RT_MIN(pImage->cbSendDataLength, cb);
3043	}
3044	if (pcszMaxBurstLength)
3045	{
3046	uint32_t cb = pImage->cbSendDataLength;
3047	rc = RTStrToUInt32Full(pcszMaxBurstLength, 0, &cb);
3048	AssertRC(rc);
3049	pImage->cbSendDataLength = RT_MIN(pImage->cbSendDataLength, cb);
3050	}
3051	if (pcszFirstBurstLength)
3052	{
3053	uint32_t cb = pImage->cbSendDataLength;
3054	rc = RTStrToUInt32Full(pcszFirstBurstLength, 0, &cb);
3055	AssertRC(rc);
3056	pImage->cbSendDataLength = RT_MIN(pImage->cbSendDataLength, cb);
3057	}
3058	return VINF_SUCCESS;
3059	}
3060
3061
3062	static bool serial_number_less(uint32_t s1, uint32_t s2)
3063	{
3064	return (s1 < s2 && s2 - s1 < 0x80000000) \|\| (s1 > s2 && s1 - s2 > 0x80000000);
3065	}
3066
3067	static bool serial_number_greater(uint32_t s1, uint32_t s2)
3068	{
3069	return (s1 < s2 && s2 - s1 > 0x80000000) \|\| (s1 > s2 && s1 - s2 < 0x80000000);
3070	}
3071
3072
3073	#ifdef IMPLEMENT_TARGET_AUTH
3074	static void chap_md5_generate_challenge(uint8_t pbChallenge, size_t pcbChallenge)
3075	{
3076	uint8_t cbChallenge;
3077
3078	cbChallenge = RTrand_U8(CHAP_MD5_CHALLENGE_MIN, CHAP_MD5_CHALLENGE_MAX);
3079	RTrand_bytes(pbChallenge, cbChallenge);
3080	*pcbChallenge = cbChallenge;
3081	}
3082	#endif
3083
3084
3085	static void chap_md5_compute_response(uint8_t pbResponse, uint8_t id, const uint8_t pbChallenge, size_t cbChallenge,
3086	const uint8_t *pbSecret, size_t cbSecret)
3087	{
3088	RTMD5CONTEXT ctx;
3089	uint8_t bId;
3090
3091	bId = id;
3092	RTMd5Init(&ctx);
3093	RTMd5Update(&ctx, &bId, 1);
3094	RTMd5Update(&ctx, pbSecret, cbSecret);
3095	RTMd5Update(&ctx, pbChallenge, cbChallenge);
3096	RTMd5Final(pbResponse, &ctx);
3097	}
3098
3099	/**
3100	* Internal. - Wrapper around the extended select callback of the net interface.
3101	*/
3102	DECLINLINE(int) iscsiIoThreadWait(PISCSIIMAGE pImage, RTMSINTERVAL cMillies, uint32_t fEvents, uint32_t *pfEvents)
3103	{
3104	return pImage->pInterfaceNetCallbacks->pfnSelectOneEx(pImage->Socket, fEvents, pfEvents, cMillies);
3105	}
3106
3107	/**
3108	* Internal. - Pokes a thread waiting for I/O.
3109	*/
3110	DECLINLINE(int) iscsiIoThreadPoke(PISCSIIMAGE pImage)
3111	{
3112	return pImage->pInterfaceNetCallbacks->pfnPoke(pImage->Socket);
3113	}
3114
3115	/**
3116	* Internal. - Get the next request from the queue.
3117	*/
3118	DECLINLINE(PISCSICMD) iscsiCmdGet(PISCSIIMAGE pImage)
3119	{
3120	int rc;
3121	PISCSICMD pIScsiCmd = NULL;
3122
3123	rc = RTSemMutexRequest(pImage->MutexReqQueue, RT_INDEFINITE_WAIT);
3124	AssertRC(rc);
3125
3126	pIScsiCmd = pImage->pScsiReqQueue;
3127	if (pIScsiCmd)
3128	{
3129	pImage->pScsiReqQueue = pIScsiCmd->pNext;
3130	pIScsiCmd->pNext = NULL;
3131	}
3132
3133	rc = RTSemMutexRelease(pImage->MutexReqQueue);
3134	AssertRC(rc);
3135
3136	return pIScsiCmd;
3137	}
3138
3139
3140	/**
3141	* Internal. - Adds the given command to the queue.
3142	*/
3143	DECLINLINE(int) iscsiCmdPut(PISCSIIMAGE pImage, PISCSICMD pIScsiCmd)
3144	{
3145	int rc = RTSemMutexRequest(pImage->MutexReqQueue, RT_INDEFINITE_WAIT);
3146	AssertRC(rc);
3147
3148	pIScsiCmd->pNext = pImage->pScsiReqQueue;
3149	pImage->pScsiReqQueue = pIScsiCmd;
3150
3151	rc = RTSemMutexRelease(pImage->MutexReqQueue);
3152	AssertRC(rc);
3153
3154	iscsiIoThreadPoke(pImage);
3155
3156	return rc;
3157	}
3158
3159	/**
3160	* Internal. - Completes the request with the appropriate action.
3161	* Synchronous requests are completed with waking up the thread
3162	* and asynchronous ones by continuing the associated I/O context.
3163	*/
3164	static void iscsiCmdComplete(PISCSIIMAGE pImage, PISCSICMD pIScsiCmd, int rcCmd)
3165	{
3166	LogFlowFunc(("pImage=%#p pIScsiCmd=%#p rcCmd=%Rrc\n", pImage, pIScsiCmd, rcCmd));
3167
3168	/* Remove from the table first. */
3169	iscsiCmdRemove(pImage, pIScsiCmd->Itt);
3170
3171	/* Call completion callback. */
3172	pIScsiCmd->pfnComplete(pImage, rcCmd, pIScsiCmd->pvUser);
3173
3174	/* Free command structure. */
3175	#ifdef DEBUG
3176	memset(pIScsiCmd, 0xff, sizeof(ISCSICMD));
3177	#endif
3178	RTMemFree(pIScsiCmd);
3179	}
3180
3181	/**
3182	* Reattaches the to the target after an error aborting
3183	* pending commands and resending them.
3184	*
3185	* @param pImage iSCSI connection state.
3186	*/
3187	static void iscsiReattach(PISCSIIMAGE pImage)
3188	{
3189	int rc = VINF_SUCCESS;
3190	PISCSICMD pIScsiCmdHead = NULL;
3191	PISCSICMD pIScsiCmd = NULL;
3192	PISCSICMD pIScsiCmdCur = NULL;
3193	PISCSIPDUTX pIScsiPDUTx = NULL;
3194
3195	/* Close connection. */
3196	iscsiTransportClose(pImage);
3197	pImage->state = ISCSISTATE_FREE;
3198
3199	/* Reset PDU we are receiving. */
3200	iscsiRecvPDUReset(pImage);
3201
3202	/*
3203	* Abort all PDUs we are about to transmit,
3204	* the command need a new Itt if the relogin is successful.
3205	*/
3206	while (pImage->pIScsiPDUTxHead)
3207	{
3208	pIScsiPDUTx = pImage->pIScsiPDUTxHead;
3209	pImage->pIScsiPDUTxHead = pIScsiPDUTx->pNext;
3210
3211	pIScsiCmd = pIScsiPDUTx->pIScsiCmd;
3212
3213	if (pIScsiCmd)
3214	{
3215	/* Place on command list. */
3216	pIScsiCmd->pNext = pIScsiCmdHead;
3217	pIScsiCmdHead = pIScsiCmd;
3218	}
3219	RTMemFree(pIScsiPDUTx);
3220	}
3221
3222	/* Clear the current PDU too. */
3223	if (pImage->pIScsiPDUTxCur)
3224	{
3225	pIScsiPDUTx = pImage->pIScsiPDUTxCur;
3226
3227	pImage->pIScsiPDUTxCur = NULL;
3228	pIScsiCmd = pIScsiPDUTx->pIScsiCmd;
3229
3230	if (pIScsiCmd)
3231	{
3232	pIScsiCmd->pNext = pIScsiCmdHead;
3233	pIScsiCmdHead = pIScsiCmd;
3234	}
3235	RTMemFree(pIScsiPDUTx);
3236	}
3237
3238	/*
3239	* Get all commands which are waiting for a response
3240	* They need to be resend too after a successful reconnect.
3241	*/
3242	pIScsiCmd = iscsiCmdRemoveAll(pImage);
3243
3244	if (pIScsiCmd)
3245	{
3246	pIScsiCmdCur = pIScsiCmd;
3247	while (pIScsiCmdCur->pNext)
3248	pIScsiCmdCur = pIScsiCmdCur->pNext;
3249
3250	/*
3251	* Place them in front of the list because they are the oldest requests
3252	* and need to be processed first to minimize the risk to time out.
3253	*/
3254	pIScsiCmdCur->pNext = pIScsiCmdHead;
3255	pIScsiCmdHead = pIScsiCmd;
3256	}
3257
3258	/* Try to attach. */
3259	rc = iscsiAttach(pImage);
3260	if (RT_SUCCESS(rc))
3261	{
3262	/* Phew, we have a connection again.
3263	* Prepare new PDUs for the aborted commands.
3264	*/
3265	while (pIScsiCmdHead)
3266	{
3267	pIScsiCmd = pIScsiCmdHead;
3268	pIScsiCmdHead = pIScsiCmdHead->pNext;
3269
3270	pIScsiCmd->pNext = NULL;
3271
3272	rc = iscsiPDUTxPrepare(pImage, pIScsiCmd);
3273	AssertRC(rc);
3274	}
3275	}
3276	else
3277	{
3278	/*
3279	* Still no luck, complete commands with error so the caller
3280	* has a chance to inform the user and maybe resend the command.
3281	*/
3282	while (pIScsiCmdHead)
3283	{
3284	pIScsiCmd = pIScsiCmdHead;
3285	pIScsiCmdHead = pIScsiCmdHead->pNext;
3286
3287	iscsiCmdComplete(pImage, pIScsiCmd, VERR_BROKEN_PIPE);
3288	}
3289	}
3290	}
3291
3292	/**
3293	* Internal. Main iSCSI I/O worker.
3294	*/
3295	static DECLCALLBACK(int) iscsiIoThreadWorker(RTTHREAD ThreadSelf, void *pvUser)
3296	{
3297	PISCSIIMAGE pImage = (PISCSIIMAGE)pvUser;
3298
3299	/* Initialize the initial event mask. */
3300	pImage->fPollEvents = VD_INTERFACETCPNET_EVT_READ \| VD_INTERFACETCPNET_EVT_ERROR;
3301
3302	while (pImage->fRunning)
3303	{
3304	uint32_t fEvents;
3305	int rc;
3306
3307	fEvents = 0;
3308
3309	/* Wait for work or for data from the target. */
3310	RTMSINTERVAL msWait;
3311
3312	if (pImage->cCmdsWaiting)
3313	{
3314	pImage->fPollEvents &= ~VD_INTERFACETCPNET_HINT_INTERRUPT;
3315	msWait = pImage->uReadTimeout;
3316	}
3317	else
3318	{
3319	pImage->fPollEvents \|= VD_INTERFACETCPNET_HINT_INTERRUPT;
3320	msWait = RT_INDEFINITE_WAIT;
3321	}
3322
3323	LogFlow(("Waiting for events fPollEvents=%#x\n", pImage->fPollEvents));
3324	rc = iscsiIoThreadWait(pImage, msWait, pImage->fPollEvents, &fEvents);
3325	if (rc == VERR_INTERRUPTED)
3326	{
3327	/* Check the queue. */
3328	PISCSICMD pIScsiCmd = iscsiCmdGet(pImage);
3329
3330	while (pIScsiCmd)
3331	{
3332	switch (pIScsiCmd->enmCmdType)
3333	{
3334	case ISCSICMDTYPE_REQ:
3335	{
3336	/* If there is no connection complete the command with an error. */
3337	if (RT_LIKELY(iscsiIsClientConnected(pImage)))
3338	{
3339	rc = iscsiPDUTxPrepare(pImage, pIScsiCmd);
3340	AssertRC(rc);
3341	}
3342	else
3343	iscsiCmdComplete(pImage, pIScsiCmd, VERR_NET_CONNECTION_REFUSED);
3344	break;
3345	}
3346	case ISCSICMDTYPE_EXEC:
3347	{
3348	rc = pIScsiCmd->CmdType.Exec.pfnExec(pIScsiCmd->CmdType.Exec.pvUser);
3349	iscsiCmdComplete(pImage, pIScsiCmd, rc);
3350	break;
3351	}
3352	default:
3353	AssertMsgFailed(("Invalid command type %d\n", pIScsiCmd->enmCmdType));
3354	}
3355
3356	pIScsiCmd = iscsiCmdGet(pImage);
3357	}
3358	}
3359	else if (rc == VERR_TIMEOUT && pImage->cCmdsWaiting)
3360	{
3361	/*
3362	* We are waiting for a response from the target but
3363	* it didn't answered yet.
3364	* We assume the connection is broken and try to reconnect.
3365	*/
3366	LogFlow(("Timed out while waiting for an answer from the target, reconnecting\n"));
3367	iscsiReattach(pImage);
3368	}
3369	else if (RT_SUCCESS(rc) \|\| rc == VERR_TIMEOUT)
3370	{
3371	Assert(pImage->state == ISCSISTATE_NORMAL);
3372	LogFlow(("Got socket events %#x\n", fEvents));
3373
3374	if (fEvents & VD_INTERFACETCPNET_EVT_READ)
3375	{
3376	/* Continue or start a new PDU receive task */
3377	LogFlow(("There is data on the socket\n"));
3378	rc = iscsiRecvPDUAsync(pImage);
3379	if (rc == VERR_BROKEN_PIPE)
3380	iscsiReattach(pImage);
3381	else if (RT_FAILURE(rc))
3382	LogRel(("iSCSI: Handling incoming request failed %Rrc\n", rc));
3383	}
3384
3385	if (fEvents & VD_INTERFACETCPNET_EVT_WRITE)
3386	{
3387	LogFlow(("The socket is writable\n"));
3388	rc = iscsiSendPDUAsync(pImage);
3389	if (RT_FAILURE(rc))
3390	LogRel(("iSCSI: Sending PDU failed %Rrc\n", rc));
3391	}
3392
3393	if (fEvents & VD_INTERFACETCPNET_EVT_ERROR)
3394	{
3395	LogFlow(("An error ocurred\n"));
3396	iscsiReattach(pImage);
3397	}
3398	}
3399	else
3400	{
3401	LogRel(("iSCSI: Waiting for I/O failed rc=%Rrc\n", rc));
3402	}
3403	}
3404
3405	return VINF_SUCCESS;
3406	}
3407
3408	/**
3409	* Internal. - Enqueues a request asynchronously.
3410	*/
3411	static int iscsiCommandAsync(PISCSIIMAGE pImage, PSCSIREQ pScsiReq,
3412	PFNISCSICMDCOMPLETED pfnComplete, void *pvUser)
3413	{
3414	int rc;
3415
3416	if (pImage->fExtendedSelectSupported)
3417	{
3418	PISCSICMD pIScsiCmd = (PISCSICMD)RTMemAllocZ(sizeof(ISCSICMD));
3419	if (!pIScsiCmd)
3420	return VERR_NO_MEMORY;
3421
3422	/* Init the command structure. */
3423	pIScsiCmd->pNext = NULL;
3424	pIScsiCmd->enmCmdType = ISCSICMDTYPE_REQ;
3425	pIScsiCmd->pfnComplete = pfnComplete;
3426	pIScsiCmd->pvUser = pvUser;
3427	pIScsiCmd->CmdType.ScsiReq.pScsiReq = pScsiReq;
3428
3429	rc = iscsiCmdPut(pImage, pIScsiCmd);
3430	if (RT_FAILURE(rc))
3431	RTMemFree(pIScsiCmd);
3432	}
3433	else
3434	rc = VERR_NOT_SUPPORTED;
3435
3436	return rc;
3437	}
3438
3439	static void iscsiCommandCompleteSync(PISCSIIMAGE pImage, int rcReq, void *pvUser)
3440	{
3441	PISCSICMDSYNC pIScsiCmdSync = (PISCSICMDSYNC)pvUser;
3442
3443	pIScsiCmdSync->rcCmd = rcReq;
3444	int rc = RTSemEventSignal(pIScsiCmdSync->EventSem);
3445	AssertRC(rc);
3446	}
3447
3448	/**
3449	* Internal. - Enqueues a request in a synchronous fashion
3450	* i.e. returns when the request completed.
3451	*/
3452	static int iscsiCommandSync(PISCSIIMAGE pImage, PSCSIREQ pScsiReq, bool fRetry, int rcSense)
3453	{
3454	int rc;
3455
3456	if (pImage->fExtendedSelectSupported)
3457	{
3458	ISCSICMDSYNC IScsiCmdSync;
3459
3460	/* Create event semaphore. */
3461	rc = RTSemEventCreate(&IScsiCmdSync.EventSem);
3462	if (RT_FAILURE(rc))
3463	return rc;
3464
3465	if (fRetry)
3466	{
3467	for (unsigned i = 0; i < 10; i++)
3468	{
3469	rc = iscsiCommandAsync(pImage, pScsiReq, iscsiCommandCompleteSync, &IScsiCmdSync);
3470	if (RT_FAILURE(rc))
3471	break;
3472
3473	rc = RTSemEventWait(IScsiCmdSync.EventSem, RT_INDEFINITE_WAIT);
3474	AssertRC(rc);
3475	rc = IScsiCmdSync.rcCmd;
3476
3477	if ( (RT_SUCCESS(rc) && !pScsiReq->cbSense)
3478	\|\| RT_FAILURE(rc))
3479	break;
3480	rc = rcSense;
3481	}
3482	}
3483	else
3484	{
3485	rc = iscsiCommandAsync(pImage, pScsiReq, iscsiCommandCompleteSync, &IScsiCmdSync);
3486	if (RT_SUCCESS(rc))
3487	{
3488	rc = RTSemEventWait(IScsiCmdSync.EventSem, RT_INDEFINITE_WAIT);
3489	AssertRC(rc);
3490	rc = IScsiCmdSync.rcCmd;
3491
3492	if (RT_FAILURE(rc) \|\| pScsiReq->cbSense > 0)
3493	rc = rcSense;
3494	}
3495	}
3496
3497	RTSemEventDestroy(IScsiCmdSync.EventSem);
3498	}
3499	else
3500	{
3501	if (fRetry)
3502	{
3503	for (unsigned i = 0; i < 10; i++)
3504	{
3505	rc = iscsiCommand(pImage, pScsiReq);
3506	if ( (RT_SUCCESS(rc) && !pScsiReq->cbSense)
3507	\|\| RT_FAILURE(rc))
3508	break;
3509	rc = rcSense;
3510	}
3511	}
3512	else
3513	{
3514	rc = iscsiCommand(pImage, pScsiReq);
3515	if (RT_SUCCESS(rc) && pScsiReq->cbSense > 0)
3516	rc = rcSense;
3517	}
3518	}
3519
3520	return rc;
3521	}
3522
3523
3524	/**
3525	* Internal. - Executes a given function in a synchronous fashion
3526	* on the I/O thread if available.
3527	*/
3528	static int iscsiExecSync(PISCSIIMAGE pImage, PFNISCSIEXEC pfnExec, void *pvUser)
3529	{
3530	int rc;
3531
3532	if (pImage->fExtendedSelectSupported)
3533	{
3534	ISCSICMDSYNC IScsiCmdSync;
3535	PISCSICMD pIScsiCmd = (PISCSICMD)RTMemAllocZ(sizeof(ISCSICMD));
3536	if (!pIScsiCmd)
3537	return VERR_NO_MEMORY;
3538
3539	/* Create event semaphore. */
3540	rc = RTSemEventCreate(&IScsiCmdSync.EventSem);
3541	if (RT_FAILURE(rc))
3542	{
3543	RTMemFree(pIScsiCmd);
3544	return rc;
3545	}
3546
3547	/* Init the command structure. */
3548	pIScsiCmd->pNext = NULL;
3549	pIScsiCmd->enmCmdType = ISCSICMDTYPE_EXEC;
3550	pIScsiCmd->pfnComplete = iscsiCommandCompleteSync;
3551	pIScsiCmd->pvUser = &IScsiCmdSync;
3552	pIScsiCmd->CmdType.Exec.pfnExec = pfnExec;
3553	pIScsiCmd->CmdType.Exec.pvUser = pvUser;
3554
3555	rc = iscsiCmdPut(pImage, pIScsiCmd);
3556	if (RT_FAILURE(rc))
3557	RTMemFree(pIScsiCmd);
3558	else
3559	{
3560	rc = RTSemEventWait(IScsiCmdSync.EventSem, RT_INDEFINITE_WAIT);
3561	AssertRC(rc);
3562	rc = IScsiCmdSync.rcCmd;
3563	}
3564
3565	RTSemEventDestroy(IScsiCmdSync.EventSem);
3566	}
3567	else
3568	{
3569	/* No I/O thread, execute in the current thread. */
3570	rc = pfnExec(pvUser);
3571	}
3572
3573	return rc;
3574	}
3575
3576
3577	static void iscsiCommandAsyncComplete(PISCSIIMAGE pImage, int rcReq, void *pvUser)
3578	{
3579	bool fComplete = true;
3580	size_t cbTransfered = 0;
3581	PSCSIREQASYNC pReqAsync = (PSCSIREQASYNC)pvUser;
3582	PSCSIREQ pScsiReq = pReqAsync->pScsiReq;
3583
3584	if ( RT_SUCCESS(rcReq)
3585	&& pScsiReq->cbSense > 0)
3586	{
3587	/* Try again if possible. */
3588	if (pReqAsync->cSenseRetries > 0)
3589	{
3590	pReqAsync->cSenseRetries--;
3591	pScsiReq->cbSense = sizeof(pReqAsync->abSense);
3592	int rc = iscsiCommandAsync(pImage, pScsiReq, iscsiCommandAsyncComplete, pReqAsync);
3593	if (RT_SUCCESS(rc))
3594	fComplete = false;
3595	else
3596	rcReq = pReqAsync->rcSense;
3597	}
3598	else
3599	rcReq = pReqAsync->rcSense;
3600	}
3601
3602	if (fComplete)
3603	{
3604	if (pScsiReq->enmXfer == SCSIXFER_FROM_TARGET)
3605	cbTransfered = pScsiReq->cbT2IData;
3606	else if (pScsiReq->enmXfer == SCSIXFER_TO_TARGET)
3607	cbTransfered = pScsiReq->cbI2TData;
3608	else
3609	AssertMsg(pScsiReq->enmXfer == SCSIXFER_NONE, ("To/From transfers are not supported yet\n"));
3610
3611	/* Continue I/O context. */
3612	pImage->pInterfaceIoCallbacks->pfnIoCtxCompleted(pImage->pInterfaceIo->pvUser,
3613	pReqAsync->pIoCtx, rcReq,
3614	cbTransfered);
3615
3616	RTMemFree(pScsiReq);
3617	RTMemFree(pReqAsync);
3618	}
3619	}
3620
3621
3622	/**
3623	* Internal. Free all allocated space for representing an image, and optionally
3624	* delete the image from disk.
3625	*/
3626	static int iscsiFreeImage(PISCSIIMAGE pImage, bool fDelete)
3627	{
3628	int rc = VINF_SUCCESS;
3629	Assert(!fDelete); /* This MUST be false, the flag isn't supported. */
3630
3631	/* Freeing a never allocated image (e.g. because the open failed) is
3632	* not signalled as an error. After all nothing bad happens. */
3633	if (pImage)
3634	{
3635	if (pImage->Mutex != NIL_RTSEMMUTEX)
3636	{
3637	/* Detaching only makes sense when the mutex is there. Otherwise the
3638	* failure happened long before we could attach to the target. */
3639	iscsiExecSync(pImage, iscsiDetach, pImage);
3640	RTSemMutexDestroy(pImage->Mutex);
3641	pImage->Mutex = NIL_RTSEMMUTEX;
3642	}
3643	if (pImage->hThreadIo != NIL_RTTHREAD)
3644	{
3645	ASMAtomicXchgBool(&pImage->fRunning, false);
3646	rc = iscsiIoThreadPoke(pImage);
3647	AssertRC(rc);
3648
3649	/* Wait for the thread to terminate. */
3650	rc = RTThreadWait(pImage->hThreadIo, RT_INDEFINITE_WAIT, NULL);
3651	AssertRC(rc);
3652	}
3653	/* Destroy the socket. */
3654	if (pImage->Socket != NIL_VDSOCKET)
3655	{
3656	pImage->pInterfaceNetCallbacks->pfnSocketDestroy(pImage->Socket);
3657	}
3658	if (pImage->MutexReqQueue != NIL_RTSEMMUTEX)
3659	{
3660	RTSemMutexDestroy(pImage->MutexReqQueue);
3661	pImage->MutexReqQueue = NIL_RTSEMMUTEX;
3662	}
3663	if (pImage->pszTargetName)
3664	{
3665	RTMemFree(pImage->pszTargetName);
3666	pImage->pszTargetName = NULL;
3667	}
3668	if (pImage->pszInitiatorName)
3669	{
3670	if (pImage->fAutomaticInitiatorName)
3671	RTStrFree(pImage->pszInitiatorName);
3672	else
3673	RTMemFree(pImage->pszInitiatorName);
3674	pImage->pszInitiatorName = NULL;
3675	}
3676	if (pImage->pszInitiatorUsername)
3677	{
3678	RTMemFree(pImage->pszInitiatorUsername);
3679	pImage->pszInitiatorUsername = NULL;
3680	}
3681	if (pImage->pbInitiatorSecret)
3682	{
3683	RTMemFree(pImage->pbInitiatorSecret);
3684	pImage->pbInitiatorSecret = NULL;
3685	}
3686	if (pImage->pszTargetUsername)
3687	{
3688	RTMemFree(pImage->pszTargetUsername);
3689	pImage->pszTargetUsername = NULL;
3690	}
3691	if (pImage->pbTargetSecret)
3692	{
3693	RTMemFree(pImage->pbTargetSecret);
3694	pImage->pbTargetSecret = NULL;
3695	}
3696	if (pImage->pvRecvPDUBuf)
3697	{
3698	RTMemFree(pImage->pvRecvPDUBuf);
3699	pImage->pvRecvPDUBuf = NULL;
3700	}
3701
3702	pImage->cbRecvPDUResidual = 0;
3703	}
3704
3705	LogFlowFunc(("returns %Rrc\n", rc));
3706	return rc;
3707	}
3708
3709	/**
3710	* Internal: Open an image, constructing all necessary data structures.
3711	*/
3712	static int iscsiOpenImage(PISCSIIMAGE pImage, unsigned uOpenFlags)
3713	{
3714	int rc;
3715	char pszLUN = NULL, pszLUNInitial = NULL;
3716	bool fLunEncoded = false;
3717	uint32_t uWriteSplitDef = 0;
3718	uint32_t uTimeoutDef = 0;
3719	uint64_t uHostIPTmp = 0;
3720	bool fHostIPDef = 0;
3721	rc = RTStrToUInt32Full(s_iscsiConfigDefaultWriteSplit, 0, &uWriteSplitDef);
3722	AssertRC(rc);
3723	rc = RTStrToUInt32Full(s_iscsiConfigDefaultTimeout, 0, &uTimeoutDef);
3724	AssertRC(rc);
3725	rc = RTStrToUInt64Full(s_iscsiConfigDefaultHostIPStack, 0, &uHostIPTmp);
3726	AssertRC(rc);
3727	fHostIPDef = !!uHostIPTmp;
3728
3729	pImage->uOpenFlags = uOpenFlags;
3730
3731	/* Get error signalling interface. */
3732	pImage->pInterfaceError = VDInterfaceGet(pImage->pVDIfsDisk, VDINTERFACETYPE_ERROR);
3733	if (pImage->pInterfaceError)
3734	pImage->pInterfaceErrorCallbacks = VDGetInterfaceError(pImage->pInterfaceError);
3735
3736	/* Get TCP network stack interface. */
3737	pImage->pInterfaceNet = VDInterfaceGet(pImage->pVDIfsImage, VDINTERFACETYPE_TCPNET);
3738	if (pImage->pInterfaceNet)
3739	pImage->pInterfaceNetCallbacks = VDGetInterfaceTcpNet(pImage->pInterfaceNet);
3740	else
3741	{
3742	rc = iscsiError(pImage, VERR_VD_ISCSI_UNKNOWN_INTERFACE,
3743	RT_SRC_POS, N_("iSCSI: TCP network stack interface missing"));
3744	goto out;
3745	}
3746
3747	/* Get configuration interface. */
3748	pImage->pInterfaceConfig = VDInterfaceGet(pImage->pVDIfsImage, VDINTERFACETYPE_CONFIG);
3749	if (pImage->pInterfaceConfig)
3750	pImage->pInterfaceConfigCallbacks = VDGetInterfaceConfig(pImage->pInterfaceConfig);
3751	else
3752	{
3753	rc = iscsiError(pImage, VERR_VD_ISCSI_UNKNOWN_INTERFACE,
3754	RT_SRC_POS, N_("iSCSI: configuration interface missing"));
3755	goto out;
3756	}
3757
3758	/* Get I/O interface. */
3759	pImage->pInterfaceIo = VDInterfaceGet(pImage->pVDIfsImage, VDINTERFACETYPE_IOINT);
3760	if (pImage->pInterfaceIo)
3761	pImage->pInterfaceIoCallbacks = VDGetInterfaceIOInt(pImage->pInterfaceIo);
3762	else
3763	{
3764	rc = iscsiError(pImage, VERR_VD_ISCSI_UNKNOWN_INTERFACE,
3765	RT_SRC_POS, N_("iSCSI: I/O interface missing"));
3766	goto out;
3767	}
3768
3769	/* This ISID will be adjusted later to make it unique on this host. */
3770	pImage->ISID = 0x800000000000ULL \| 0x001234560000ULL;
3771	pImage->cISCSIRetries = 10;
3772	pImage->state = ISCSISTATE_FREE;
3773	pImage->pvRecvPDUBuf = RTMemAlloc(ISCSI_RECV_PDU_BUFFER_SIZE);
3774	pImage->cbRecvPDUBuf = ISCSI_RECV_PDU_BUFFER_SIZE;
3775	if (pImage->pvRecvPDUBuf == NULL)
3776	{
3777	rc = VERR_NO_MEMORY;
3778	goto out;
3779	}
3780	pImage->Mutex = NIL_RTSEMMUTEX;
3781	pImage->MutexReqQueue = NIL_RTSEMMUTEX;
3782	rc = RTSemMutexCreate(&pImage->Mutex);
3783	if (RT_FAILURE(rc))
3784	goto out;
3785
3786	rc = RTSemMutexCreate(&pImage->MutexReqQueue);
3787	if (RT_FAILURE(rc))
3788	goto out;
3789
3790	/* Validate configuration, detect unknown keys. */
3791	if (!VDCFGAreKeysValid(pImage->pInterfaceConfigCallbacks,
3792	pImage->pInterfaceConfig->pvUser,
3793	"TargetName\0InitiatorName\0LUN\0TargetAddress\0InitiatorUsername\0InitiatorSecret\0TargetUsername\0TargetSecret\0WriteSplit\0Timeout\0HostIPStack\0"))
3794	{
3795	rc = iscsiError(pImage, VERR_VD_ISCSI_UNKNOWN_CFG_VALUES, RT_SRC_POS, N_("iSCSI: configuration error: unknown configuration keys present"));
3796	goto out;
3797	}
3798
3799	/* Query the iSCSI upper level configuration. */
3800	rc = VDCFGQueryStringAlloc(pImage->pInterfaceConfigCallbacks,
3801	pImage->pInterfaceConfig->pvUser,
3802	"TargetName", &pImage->pszTargetName);
3803	if (RT_FAILURE(rc))
3804	{
3805	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read TargetName as string"));
3806	goto out;
3807	}
3808	rc = VDCFGQueryStringAlloc(pImage->pInterfaceConfigCallbacks,
3809	pImage->pInterfaceConfig->pvUser,
3810	"InitiatorName", &pImage->pszInitiatorName);
3811	if (rc == VERR_CFGM_VALUE_NOT_FOUND \|\| rc == VERR_CFGM_NO_PARENT)
3812	{
3813	pImage->fAutomaticInitiatorName = true;
3814	rc = VINF_SUCCESS;
3815	}
3816	if (RT_FAILURE(rc))
3817	{
3818	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read InitiatorName as string"));
3819	goto out;
3820	}
3821	rc = VDCFGQueryStringAllocDef(pImage->pInterfaceConfigCallbacks,
3822	pImage->pInterfaceConfig->pvUser,
3823	"LUN", &pszLUN, s_iscsiConfigDefaultLUN);
3824	if (RT_FAILURE(rc))
3825	{
3826	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read LUN as string"));
3827	goto out;
3828	}
3829	pszLUNInitial = pszLUN;
3830	if (!strncmp(pszLUN, "enc", 3))
3831	{
3832	fLunEncoded = true;
3833	pszLUN += 3;
3834	}
3835	rc = RTStrToUInt64Full(pszLUN, 0, &pImage->LUN);
3836	if (RT_FAILURE(rc))
3837	{
3838	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to convert LUN to integer"));
3839	goto out;
3840	}
3841	if (!fLunEncoded)
3842	{
3843	if (pImage->LUN <= 255)
3844	{
3845	pImage->LUN = pImage->LUN << 48; /* uses peripheral device addressing method */
3846	}
3847	else if (pImage->LUN <= 16383)
3848	{
3849	pImage->LUN = (pImage->LUN << 48) \| RT_BIT_64(62); /* uses flat space addressing method */
3850	}
3851	else
3852	{
3853	rc = VERR_OUT_OF_RANGE;
3854	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: LUN number out of range (0-16383)"));
3855	goto out;
3856	}
3857	}
3858	rc = VDCFGQueryStringAlloc(pImage->pInterfaceConfigCallbacks,
3859	pImage->pInterfaceConfig->pvUser,
3860	"TargetAddress", &pImage->pszTargetAddress);
3861	if (RT_FAILURE(rc))
3862	{
3863	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read TargetAddress as string"));
3864	goto out;
3865	}
3866	pImage->pszInitiatorUsername = NULL;
3867	rc = VDCFGQueryStringAlloc(pImage->pInterfaceConfigCallbacks,
3868	pImage->pInterfaceConfig->pvUser,
3869	"InitiatorUsername",
3870	&pImage->pszInitiatorUsername);
3871	if (rc == VERR_CFGM_VALUE_NOT_FOUND \|\| rc == VERR_CFGM_NO_PARENT)
3872	rc = VINF_SUCCESS;
3873	if (RT_FAILURE(rc))
3874	{
3875	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read InitiatorUsername as string"));
3876	goto out;
3877	}
3878	pImage->pbInitiatorSecret = NULL;
3879	pImage->cbInitiatorSecret = 0;
3880	rc = VDCFGQueryBytesAlloc(pImage->pInterfaceConfigCallbacks,
3881	pImage->pInterfaceConfig->pvUser,
3882	"InitiatorSecret",
3883	(void **)&pImage->pbInitiatorSecret,
3884	&pImage->cbInitiatorSecret);
3885	if (rc == VERR_CFGM_VALUE_NOT_FOUND \|\| rc == VERR_CFGM_NO_PARENT)
3886	rc = VINF_SUCCESS;
3887	if (RT_FAILURE(rc))
3888	{
3889	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read InitiatorSecret as byte string"));
3890	goto out;
3891	}
3892	pImage->pszTargetUsername = NULL;
3893	rc = VDCFGQueryStringAlloc(pImage->pInterfaceConfigCallbacks,
3894	pImage->pInterfaceConfig->pvUser,
3895	"TargetUsername",
3896	&pImage->pszTargetUsername);
3897	if (rc == VERR_CFGM_VALUE_NOT_FOUND \|\| rc == VERR_CFGM_NO_PARENT)
3898	rc = VINF_SUCCESS;
3899	if (RT_FAILURE(rc))
3900	{
3901	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read TargetUsername as string"));
3902	goto out;
3903	}
3904	pImage->pbTargetSecret = NULL;
3905	pImage->cbTargetSecret = 0;
3906	rc = VDCFGQueryBytesAlloc(pImage->pInterfaceConfigCallbacks,
3907	pImage->pInterfaceConfig->pvUser,
3908	"TargetSecret", (void **)&pImage->pbTargetSecret,
3909	&pImage->cbTargetSecret);
3910	if (rc == VERR_CFGM_VALUE_NOT_FOUND \|\| rc == VERR_CFGM_NO_PARENT)
3911	rc = VINF_SUCCESS;
3912	if (RT_FAILURE(rc))
3913	{
3914	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read TargetSecret as byte string"));
3915	goto out;
3916	}
3917	rc = VDCFGQueryU32Def(pImage->pInterfaceConfigCallbacks,
3918	pImage->pInterfaceConfig->pvUser,
3919	"WriteSplit", &pImage->cbWriteSplit,
3920	uWriteSplitDef);
3921	if (RT_FAILURE(rc))
3922	{
3923	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read WriteSplit as U32"));
3924	goto out;
3925	}
3926
3927	pImage->pszHostname = NULL;
3928	pImage->uPort = 0;
3929	pImage->Socket = NIL_VDSOCKET;
3930	/* Query the iSCSI lower level configuration. */
3931	rc = VDCFGQueryU32Def(pImage->pInterfaceConfigCallbacks,
3932	pImage->pInterfaceConfig->pvUser,
3933	"Timeout", &pImage->uReadTimeout,
3934	uTimeoutDef);
3935	if (RT_FAILURE(rc))
3936	{
3937	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read Timeout as U32"));
3938	goto out;
3939	}
3940	rc = VDCFGQueryBoolDef(pImage->pInterfaceConfigCallbacks,
3941	pImage->pInterfaceConfig->pvUser,
3942	"HostIPStack", &pImage->fHostIP,
3943	fHostIPDef);
3944	if (RT_FAILURE(rc))
3945	{
3946	rc = iscsiError(pImage, rc, RT_SRC_POS, N_("iSCSI: configuration error: failed to read HostIPStack as boolean"));
3947	goto out;
3948	}
3949
3950	/* Don't actually establish iSCSI transport connection if this is just an
3951	* open to query the image information and the host IP stack isn't used.
3952	* Even trying is rather useless, as in this context the InTnet IP stack
3953	* isn't present. Returning dummies is the best possible result anyway. */
3954	if ((uOpenFlags & VD_OPEN_FLAGS_INFO) && !pImage->fHostIP)
3955	{
3956	LogFunc(("Not opening the transport connection as IntNet IP stack is not available. Will return dummies\n"));
3957	goto out;
3958	}
3959
3960	memset(pImage->aCmdsWaiting, 0, sizeof(pImage->aCmdsWaiting));
3961	pImage->cbRecvPDUResidual = 0;
3962
3963	/* Create the socket structure. */
3964	rc = pImage->pInterfaceNetCallbacks->pfnSocketCreate(VD_INTERFACETCPNET_CONNECT_EXTENDED_SELECT,
3965	&pImage->Socket);
3966	if (RT_SUCCESS(rc))
3967	{
3968	pImage->fExtendedSelectSupported = true;
3969	pImage->fRunning = true;
3970	rc = RTThreadCreate(&pImage->hThreadIo, iscsiIoThreadWorker, pImage, 0,
3971	RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE, "iSCSI-Io");
3972	if (RT_FAILURE(rc))
3973	{
3974	LogFunc(("Creating iSCSI I/O thread failed rc=%Rrc\n", rc));
3975	goto out;
3976	}
3977	}
3978	else if (rc == VERR_NOT_SUPPORTED)
3979	{
3980	/* Async I/O is not supported without extended select. */
3981	if ((uOpenFlags & VD_OPEN_FLAGS_ASYNC_IO))
3982	{
3983	LogFunc(("Extended select is not supported by the interface but async I/O is requested -> %Rrc\n", rc));
3984	goto out;
3985	}
3986	else
3987	{
3988	pImage->fExtendedSelectSupported = false;
3989	rc = pImage->pInterfaceNetCallbacks->pfnSocketCreate(0, &pImage->Socket);
3990	if (RT_FAILURE(rc))
3991	{
3992	LogFunc(("Creating socket failed -> %Rrc\n", rc));
3993	goto out;
3994	}
3995	}
3996	}
3997	else
3998	{
3999	LogFunc(("Creating socket failed -> %Rrc\n", rc));
4000	goto out;
4001	}
4002
4003	/*
4004	* Attach to the iSCSI target. This implicitly establishes the iSCSI
4005	* transport connection.
4006	*/
4007	rc = iscsiExecSync(pImage, iscsiAttach, pImage);
4008	if (RT_FAILURE(rc))
4009	{
4010	LogRel(("iSCSI: could not open target %s, rc=%Rrc\n", pImage->pszTargetName, rc));
4011	goto out;
4012	}
4013	LogFlowFunc(("target '%s' opened successfully\n", pImage->pszTargetName));
4014
4015	SCSIREQ sr;
4016	RTSGSEG DataSeg;
4017	uint8_t sense[96];
4018	uint8_t data8[8];
4019	uint8_t data12[12];
4020
4021	/*
4022	* Inquire available LUNs - purely dummy request.
4023	*/
4024	uint8_t CDB_rlun[12];
4025	uint8_t rlundata[16];
4026	CDB_rlun[0] = SCSI_REPORT_LUNS;
4027	CDB_rlun[1] = 0; /* reserved */
4028	CDB_rlun[2] = 0; /* reserved */
4029	CDB_rlun[3] = 0; /* reserved */
4030	CDB_rlun[4] = 0; /* reserved */
4031	CDB_rlun[5] = 0; /* reserved */
4032	CDB_rlun[6] = sizeof(rlundata) >> 24;
4033	CDB_rlun[7] = (sizeof(rlundata) >> 16) & 0xff;
4034	CDB_rlun[8] = (sizeof(rlundata) >> 8) & 0xff;
4035	CDB_rlun[9] = sizeof(rlundata) & 0xff;
4036	CDB_rlun[10] = 0; /* reserved */
4037	CDB_rlun[11] = 0; /* control */
4038
4039	DataSeg.pvSeg = rlundata;
4040	DataSeg.cbSeg = sizeof(rlundata);
4041
4042	sr.enmXfer = SCSIXFER_FROM_TARGET;
4043	sr.cbCDB = sizeof(CDB_rlun);
4044	sr.pvCDB = CDB_rlun;
4045	sr.cbI2TData = 0;
4046	sr.paI2TSegs = NULL;
4047	sr.cI2TSegs = 0;
4048	sr.cbT2IData = DataSeg.cbSeg;
4049	sr.paT2ISegs = &DataSeg;
4050	sr.cT2ISegs = 1;
4051	sr.cbSense = sizeof(sense);
4052	sr.pvSense = sense;
4053
4054	rc = iscsiCommandSync(pImage, &sr, false, VERR_INVALID_STATE);
4055	if (RT_FAILURE(rc))
4056	{
4057	LogRel(("iSCSI: Could not get LUN info for target %s, rc=%Rrc\n", pImage->pszTargetName, rc));
4058	return rc;
4059	}
4060
4061	/*
4062	* Inquire device characteristics - no tapes, scanners etc., please.
4063	*/
4064	uint8_t CDB_inq[6];
4065	CDB_inq[0] = SCSI_INQUIRY;
4066	CDB_inq[1] = 0; /* reserved */
4067	CDB_inq[2] = 0; /* reserved */
4068	CDB_inq[3] = 0; /* reserved */
4069	CDB_inq[4] = sizeof(data8);
4070	CDB_inq[5] = 0; /* control */
4071
4072	DataSeg.pvSeg = data8;
4073	DataSeg.cbSeg = sizeof(data8);
4074
4075	sr.enmXfer = SCSIXFER_FROM_TARGET;
4076	sr.cbCDB = sizeof(CDB_inq);
4077	sr.pvCDB = CDB_inq;
4078	sr.cbI2TData = 0;
4079	sr.paI2TSegs = NULL;
4080	sr.cI2TSegs = 0;
4081	sr.cbT2IData = DataSeg.cbSeg;
4082	sr.paT2ISegs = &DataSeg;
4083	sr.cT2ISegs = 1;
4084	sr.cbSense = sizeof(sense);
4085	sr.pvSense = sense;
4086
4087	rc = iscsiCommandSync(pImage, &sr, true /* fRetry */, VERR_INVALID_STATE);
4088	if (RT_SUCCESS(rc))
4089	{
4090	uint8_t devType = (sr.cbT2IData > 0) ? data8[0] & SCSI_DEVTYPE_MASK : 255;
4091	if (devType != SCSI_DEVTYPE_DISK)
4092	{
4093	rc = iscsiError(pImage, VERR_VD_ISCSI_INVALID_TYPE,
4094	RT_SRC_POS, N_("iSCSI: target address %s, target name %s, SCSI LUN %lld reports device type=%u"),
4095	pImage->pszTargetAddress, pImage->pszTargetName,
4096	pImage->LUN, devType);
4097	LogRel(("iSCSI: Unsupported SCSI peripheral device type %d for target %s\n", devType & SCSI_DEVTYPE_MASK, pImage->pszTargetName));
4098	goto out;
4099	}
4100	uint8_t uCmdQueue = (sr.cbT2IData >= 8) ? data8[7] & SCSI_INQUIRY_CMDQUE_MASK : 0;
4101	if (uCmdQueue > 0)
4102	pImage->fCmdQueuingSupported = true;
4103	else if (uOpenFlags & VD_OPEN_FLAGS_ASYNC_IO)
4104	{
4105	rc = VERR_NOT_SUPPORTED;
4106	goto out;
4107	}
4108
4109	LogRel(("iSCSI: target address %s, target name %s, %s command queuing\n",
4110	pImage->pszTargetAddress, pImage->pszTargetName,
4111	pImage->fCmdQueuingSupported ? "supports" : "doesn't support"));
4112	}
4113	else
4114	{
4115	LogRel(("iSCSI: Could not get INQUIRY info for target %s, rc=%Rrc\n", pImage->pszTargetName, rc));
4116	goto out;
4117	}
4118
4119	/*
4120	* Query write disable bit in the device specific parameter entry in the
4121	* mode parameter header. Refuse read/write opening of read only disks.
4122	*/
4123
4124	uint8_t CDB_ms[6];
4125	uint8_t data4[4];
4126	CDB_ms[0] = SCSI_MODE_SENSE_6;
4127	CDB_ms[1] = 0; /* dbd=0/reserved */
4128	CDB_ms[2] = 0x3f; /* pc=0/page code=0x3f, ask for all pages */
4129	CDB_ms[3] = 0; /* subpage code=0, return everything in page_0 format */
4130	CDB_ms[4] = sizeof(data4); /* allocation length=4 */
4131	CDB_ms[5] = 0; /* control */
4132
4133	DataSeg.pvSeg = data4;
4134	DataSeg.cbSeg = sizeof(data4);
4135
4136	sr.enmXfer = SCSIXFER_FROM_TARGET;
4137	sr.cbCDB = sizeof(CDB_ms);
4138	sr.pvCDB = CDB_ms;
4139	sr.cbI2TData = 0;
4140	sr.paI2TSegs = NULL;
4141	sr.cI2TSegs = 0;
4142	sr.cbT2IData = DataSeg.cbSeg;
4143	sr.paT2ISegs = &DataSeg;
4144	sr.cT2ISegs = 1;
4145	sr.cbSense = sizeof(sense);
4146	sr.pvSense = sense;
4147
4148	rc = iscsiCommandSync(pImage, &sr, true /* fRetry */, VERR_INVALID_STATE);
4149	if (RT_SUCCESS(rc))
4150	{
4151	if (!(uOpenFlags & VD_OPEN_FLAGS_READONLY) && data4[2] & 0x80)
4152	{
4153	rc = VERR_VD_IMAGE_READ_ONLY;
4154	goto out;
4155	}
4156	}
4157	else
4158	{
4159	LogRel(("iSCSI: Could not get MODE SENSE info for target %s, rc=%Rrc\n", pImage->pszTargetName, rc));
4160	goto out;
4161	}
4162
4163	/*
4164	* Determine sector size and capacity of the volume immediately.
4165	*/
4166	uint8_t CDB_cap[16];
4167
4168	RT_ZERO(data12);
4169	RT_ZERO(CDB_cap);
4170	CDB_cap[0] = SCSI_SERVICE_ACTION_IN_16;
4171	CDB_cap[1] = SCSI_SVC_ACTION_IN_READ_CAPACITY_16; /* subcommand */
4172	CDB_cap[10+3] = sizeof(data12); /* allocation length (dword) */
4173
4174	DataSeg.pvSeg = data12;
4175	DataSeg.cbSeg = sizeof(data12);
4176
4177	sr.enmXfer = SCSIXFER_FROM_TARGET;
4178	sr.cbCDB = sizeof(CDB_cap);
4179	sr.pvCDB = CDB_cap;
4180	sr.cbI2TData = 0;
4181	sr.paI2TSegs = NULL;
4182	sr.cI2TSegs = 0;
4183	sr.cbT2IData = DataSeg.cbSeg;
4184	sr.paT2ISegs = &DataSeg;
4185	sr.cT2ISegs = 1;
4186	sr.cbSense = sizeof(sense);
4187	sr.pvSense = sense;
4188
4189	rc = iscsiCommandSync(pImage, &sr, false /* fRetry */, VINF_SUCCESS);
4190	if ( RT_SUCCESS(rc)
4191	&& sr.status == SCSI_STATUS_OK)
4192	{
4193	pImage->cVolume = RT_BE2H_U64((uint64_t )&data12[0]);
4194	pImage->cVolume++;
4195	pImage->cbSector = RT_BE2H_U32((uint32_t )&data12[8]);
4196	pImage->cbSize = pImage->cVolume * pImage->cbSector;
4197	if (pImage->cVolume == 0 \|\| pImage->cbSector != 512 \|\| pImage->cbSize < pImage->cVolume)
4198	{
4199	rc = iscsiError(pImage, VERR_VD_ISCSI_INVALID_TYPE,
4200	RT_SRC_POS, N_("iSCSI: target address %s, target name %s, SCSI LUN %lld reports media sector count=%llu sector size=%u"),
4201	pImage->pszTargetAddress, pImage->pszTargetName,
4202	pImage->LUN, pImage->cVolume, pImage->cbSector);
4203	}
4204	}
4205	else
4206	{
4207	uint8_t CDB_capfb[10];
4208
4209	RT_ZERO(data8);
4210	CDB_capfb[0] = SCSI_READ_CAPACITY;
4211	CDB_capfb[1] = 0; /* reserved */
4212	CDB_capfb[2] = 0; /* reserved */
4213	CDB_capfb[3] = 0; /* reserved */
4214	CDB_capfb[4] = 0; /* reserved */
4215	CDB_capfb[5] = 0; /* reserved */
4216	CDB_capfb[6] = 0; /* reserved */
4217	CDB_capfb[7] = 0; /* reserved */
4218	CDB_capfb[8] = 0; /* reserved */
4219	CDB_capfb[9] = 0; /* control */
4220
4221	DataSeg.pvSeg = data8;
4222	DataSeg.cbSeg = sizeof(data8);
4223
4224	sr.enmXfer = SCSIXFER_FROM_TARGET;
4225	sr.cbCDB = sizeof(CDB_capfb);
4226	sr.pvCDB = CDB_capfb;
4227	sr.cbI2TData = 0;
4228	sr.paI2TSegs = NULL;
4229	sr.cI2TSegs = 0;
4230	sr.cbT2IData = DataSeg.cbSeg;
4231	sr.paT2ISegs = &DataSeg;
4232	sr.cT2ISegs = 1;
4233	sr.cbSense = sizeof(sense);
4234	sr.pvSense = sense;
4235
4236	rc = iscsiCommandSync(pImage, &sr, false /* fRetry */, VINF_SUCCESS);
4237	if (RT_SUCCESS(rc))
4238	{
4239	pImage->cVolume = (data8[0] << 24) \| (data8[1] << 16) \| (data8[2] << 8) \| data8[3];
4240	pImage->cVolume++;
4241	pImage->cbSector = (data8[4] << 24) \| (data8[5] << 16) \| (data8[6] << 8) \| data8[7];
4242	pImage->cbSize = pImage->cVolume * pImage->cbSector;
4243	if (pImage->cVolume == 0 \|\| pImage->cbSector != 512)
4244	{
4245	rc = iscsiError(pImage, VERR_VD_ISCSI_INVALID_TYPE,
4246	RT_SRC_POS, N_("iSCSI: fallback capacity detectio for target address %s, target name %s, SCSI LUN %lld reports media sector count=%llu sector size=%u"),
4247	pImage->pszTargetAddress, pImage->pszTargetName,
4248	pImage->LUN, pImage->cVolume, pImage->cbSector);
4249	}
4250	}
4251	else
4252	{
4253	LogRel(("iSCSI: Could not determine capacity of target %s, rc=%Rrc\n", pImage->pszTargetName, rc));
4254	goto out;
4255	}
4256	}
4257
4258	/*
4259	* Check the read and write cache bits.
4260	* Try to enable the cache if it is disabled.
4261	*
4262	* We already checked that this is a block access device. No need
4263	* to do it again.
4264	*/
4265	uint8_t aCachingModePage[32];
4266	uint8_t aCDBModeSense6[6];
4267
4268	memset(aCachingModePage, '\0', sizeof(aCachingModePage));
4269	aCDBModeSense6[0] = SCSI_MODE_SENSE_6;
4270	aCDBModeSense6[1] = 0;
4271	aCDBModeSense6[2] = (0x00 << 6) \| (0x08 & 0x3f); /* Current values and caching mode page */
4272	aCDBModeSense6[3] = 0; /* Sub page code. */
4273	aCDBModeSense6[4] = sizeof(aCachingModePage) & 0xff;
4274	aCDBModeSense6[5] = 0;
4275
4276	DataSeg.pvSeg = aCachingModePage;
4277	DataSeg.cbSeg = sizeof(aCachingModePage);
4278
4279	sr.enmXfer = SCSIXFER_FROM_TARGET;
4280	sr.cbCDB = sizeof(aCDBModeSense6);
4281	sr.pvCDB = aCDBModeSense6;
4282	sr.cbI2TData = 0;
4283	sr.paI2TSegs = NULL;
4284	sr.cI2TSegs = 0;
4285	sr.cbT2IData = DataSeg.cbSeg;
4286	sr.paT2ISegs = &DataSeg;
4287	sr.cT2ISegs = 1;
4288	sr.cbSense = sizeof(sense);
4289	sr.pvSense = sense;
4290	rc = iscsiCommandSync(pImage, &sr, false /* fRetry */, VINF_SUCCESS);
4291	if ( RT_SUCCESS(rc)
4292	&& (sr.status == SCSI_STATUS_OK)
4293	&& (aCachingModePage[0] >= 15)
4294	&& (aCachingModePage[4 + aCachingModePage[3]] & 0x3f) == 0x08
4295	&& (aCachingModePage[4 + aCachingModePage[3] + 1] > 3))
4296	{
4297	uint32_t Offset = 4 + aCachingModePage[3];
4298	/*
4299	* Check if the read and/or the write cache is disabled.
4300	* The write cache is disabled if bit 2 (WCE) is zero and
4301	* the read cache is disabled if bit 0 (RCD) is set.
4302	*/
4303	if (!ASMBitTest(&aCachingModePage[Offset + 2], 2) \|\| ASMBitTest(&aCachingModePage[Offset + 2], 0))
4304	{
4305	/*
4306	* Write Cache Enable (WCE) bit is zero or the Read Cache Disable (RCD) is one
4307	* So one of the caches is disabled. Enable both caches.
4308	* The rest is unchanged.
4309	*/
4310	ASMBitSet(&aCachingModePage[Offset + 2], 2);
4311	ASMBitClear(&aCachingModePage[Offset + 2], 0);
4312
4313	uint8_t aCDBCaching[6];
4314	aCDBCaching[0] = SCSI_MODE_SELECT_6;
4315	aCDBCaching[1] = 0; /* Don't write the page into NV RAM. */
4316	aCDBCaching[2] = 0;
4317	aCDBCaching[3] = 0;
4318	aCDBCaching[4] = sizeof(aCachingModePage) & 0xff;
4319	aCDBCaching[5] = 0;
4320
4321	DataSeg.pvSeg = aCachingModePage;
4322	DataSeg.cbSeg = sizeof(aCachingModePage);
4323
4324	sr.enmXfer = SCSIXFER_TO_TARGET;
4325	sr.cbCDB = sizeof(aCDBCaching);
4326	sr.pvCDB = aCDBCaching;
4327	sr.cbI2TData = DataSeg.cbSeg;
4328	sr.paI2TSegs = &DataSeg;
4329	sr.cI2TSegs = 1;
4330	sr.cbT2IData = 0;
4331	sr.paT2ISegs = NULL;
4332	sr.cT2ISegs = 0;
4333	sr.cbSense = sizeof(sense);
4334	sr.pvSense = sense;
4335	sr.status = 0;
4336	rc = iscsiCommandSync(pImage, &sr, false /* fRetry */, VINF_SUCCESS);
4337	if ( RT_SUCCESS(rc)
4338	&& (sr.status == SCSI_STATUS_OK))
4339	{
4340	LogRel(("iSCSI: Enabled read and write cache of target %s\n", pImage->pszTargetName));
4341	}
4342	else
4343	{
4344	/* Log failures but continue. */
4345	LogRel(("iSCSI: Could not enable read and write cache of target %s, rc=%Rrc status=%#x\n",
4346	pImage->pszTargetName, rc, sr.status));
4347	LogRel(("iSCSI: Sense:\n%.*Rhxd\n", sr.cbSense, sense));
4348	rc = VINF_SUCCESS;
4349	}
4350	}
4351	}
4352	else
4353	{
4354	/* Log errors but continue. */
4355	LogRel(("iSCSI: Could not check write cache of target %s, rc=%Rrc, got mode page %#x\n", pImage->pszTargetName, rc,aCachingModePage[0] & 0x3f));
4356	LogRel(("iSCSI: Sense:\n%.*Rhxd\n", sr.cbSense, sense));
4357	rc = VINF_SUCCESS;
4358	}
4359
4360	out:
4361	if (RT_FAILURE(rc))
4362	iscsiFreeImage(pImage, false);
4363	return rc;
4364	}
4365
4366
4367	/** @copydoc VBOXHDDBACKEND::pfnCheckIfValid */
4368	static int iscsiCheckIfValid(const char *pszFilename, PVDINTERFACE pVDIfsDisk,
4369	PVDINTERFACE pVDIfsImage, VDTYPE *penmType)
4370	{
4371	LogFlowFunc(("pszFilename=\"%s\"\n", pszFilename));
4372
4373	/* iSCSI images can't be checked for validity this way, as the filename
4374	* just can't supply enough configuration information. */
4375	int rc = VERR_VD_ISCSI_INVALID_HEADER;
4376
4377	LogFlowFunc(("returns %Rrc\n", rc));
4378	return rc;
4379	}
4380
4381	/** @copydoc VBOXHDDBACKEND::pfnOpen */
4382	static int iscsiOpen(const char *pszFilename, unsigned uOpenFlags,
4383	PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
4384	VDTYPE enmType, void **ppBackendData)
4385	{
4386	LogFlowFunc(("pszFilename=\"%s\" uOpenFlags=%#x pVDIfsDisk=%#p pVDIfsImage=%#p ppBackendData=%#p\n", pszFilename, uOpenFlags, pVDIfsDisk, pVDIfsImage, ppBackendData));
4387	int rc;
4388	PISCSIIMAGE pImage;
4389
4390	/* Check open flags. All valid flags are supported. */
4391	if (uOpenFlags & ~VD_OPEN_FLAGS_MASK)
4392	{
4393	rc = VERR_INVALID_PARAMETER;
4394	goto out;
4395	}
4396
4397	/* Check remaining arguments. */
4398	if ( !VALID_PTR(pszFilename)
4399	\|\| !*pszFilename
4400	\|\| strchr(pszFilename, '"'))
4401	{
4402	rc = VERR_INVALID_PARAMETER;
4403	goto out;
4404	}
4405
4406	pImage = (PISCSIIMAGE)RTMemAllocZ(sizeof(ISCSIIMAGE));
4407	if (!pImage)
4408	{
4409	rc = VERR_NO_MEMORY;
4410	goto out;
4411	}
4412
4413	pImage->pszFilename = pszFilename;
4414	pImage->pszInitiatorName = NULL;
4415	pImage->pszTargetName = NULL;
4416	pImage->pszTargetAddress = NULL;
4417	pImage->pszInitiatorUsername = NULL;
4418	pImage->pbInitiatorSecret = NULL;
4419	pImage->pszTargetUsername = NULL;
4420	pImage->pbTargetSecret = NULL;
4421	pImage->paCurrReq = NULL;
4422	pImage->pvRecvPDUBuf = NULL;
4423	pImage->pszHostname = NULL;
4424	pImage->pVDIfsDisk = pVDIfsDisk;
4425	pImage->pVDIfsImage = pVDIfsImage;
4426
4427	rc = iscsiOpenImage(pImage, uOpenFlags);
4428	if (RT_SUCCESS(rc))
4429	{
4430	LogFlowFunc(("target %s cVolume %d, cbSector %d\n", pImage->pszTargetName, pImage->cVolume, pImage->cbSector));
4431	LogRel(("iSCSI: target address %s, target name %s, SCSI LUN %lld\n", pImage->pszTargetAddress, pImage->pszTargetName, pImage->LUN));
4432	*ppBackendData = pImage;
4433	}
4434	else
4435	RTMemFree(pImage);
4436
4437	out:
4438	LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
4439	return rc;
4440	}
4441
4442	/** @copydoc VBOXHDDBACKEND::pfnCreate */
4443	static int iscsiCreate(const char *pszFilename, uint64_t cbSize,
4444	unsigned uImageFlags, const char *pszComment,
4445	PCVDGEOMETRY pPCHSGeometry, PCVDGEOMETRY pLCHSGeometry,
4446	PCRTUUID pUuid, unsigned uOpenFlags,
4447	unsigned uPercentStart, unsigned uPercentSpan,
4448	PVDINTERFACE pVDIfsDisk, PVDINTERFACE pVDIfsImage,
4449	PVDINTERFACE pVDIfsOperation, void **ppBackendData)
4450	{
4451	LogFlowFunc(("pszFilename=\"%s\" cbSize=%llu uImageFlags=%#x pszComment=\"%s\" pPCHSGeometry=%#p pLCHSGeometry=%#p Uuid=%RTuuid uOpenFlags=%#x uPercentStart=%u uPercentSpan=%u pVDIfsDisk=%#p pVDIfsImage=%#p pVDIfsOperation=%#p ppBackendData=%#p", pszFilename, cbSize, uImageFlags, pszComment, pPCHSGeometry, pLCHSGeometry, pUuid, uOpenFlags, uPercentStart, uPercentSpan, pVDIfsDisk, pVDIfsImage, pVDIfsOperation, ppBackendData));
4452	int rc = VERR_NOT_SUPPORTED;
4453
4454	LogFlowFunc(("returns %Rrc (pBackendData=%#p)\n", rc, *ppBackendData));
4455	return rc;
4456	}
4457
4458	/** @copydoc VBOXHDDBACKEND::pfnClose */
4459	static int iscsiClose(void *pBackendData, bool fDelete)
4460	{
4461	LogFlowFunc(("pBackendData=%#p fDelete=%d\n", pBackendData, fDelete));
4462	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4463	int rc;
4464
4465	Assert(!fDelete); /* This flag is unsupported. */
4466
4467	rc = iscsiFreeImage(pImage, fDelete);
4468	RTMemFree(pImage);
4469
4470	LogFlowFunc(("returns %Rrc\n", rc));
4471	return rc;
4472	}
4473
4474	/** @copydoc VBOXHDDBACKEND::pfnRead */
4475	static int iscsiRead(void pBackendData, uint64_t uOffset, void pvBuf,
4476	size_t cbToRead, size_t *pcbActuallyRead)
4477	{
4478	/** @todo reinstate logging of the target everywhere - dropped temporarily */
4479	LogFlowFunc(("pBackendData=%#p uOffset=%llu pvBuf=%#p cbToRead=%zu pcbActuallyRead=%#p\n", pBackendData, uOffset, pvBuf, cbToRead, pcbActuallyRead));
4480	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4481	uint64_t lba;
4482	uint16_t tls;
4483	int rc;
4484
4485	Assert(pImage);
4486	Assert(uOffset % 512 == 0);
4487	Assert(cbToRead % 512 == 0);
4488
4489	Assert(pImage->cbSector);
4490	AssertPtr(pvBuf);
4491
4492	if ( uOffset + cbToRead > pImage->cbSize
4493	\|\| cbToRead == 0)
4494	{
4495	rc = VERR_INVALID_PARAMETER;
4496	goto out;
4497	}
4498
4499	/*
4500	* Clip read size to a value which is supported by the target.
4501	*/
4502	cbToRead = RT_MIN(cbToRead, pImage->cbRecvDataLength);
4503
4504	lba = uOffset / pImage->cbSector;
4505	tls = (uint16_t)(cbToRead / pImage->cbSector);
4506	SCSIREQ sr;
4507	RTSGSEG T2ISeg;
4508	size_t cbCDB;
4509	uint8_t abCDB[16];
4510	uint8_t sense[96];
4511
4512	if (pImage->cVolume < _4G)
4513	{
4514	cbCDB = 10;
4515	abCDB[0] = SCSI_READ_10;
4516	abCDB[1] = 0; /* reserved */
4517	abCDB[2] = (lba >> 24) & 0xff;
4518	abCDB[3] = (lba >> 16) & 0xff;
4519	abCDB[4] = (lba >> 8) & 0xff;
4520	abCDB[5] = lba & 0xff;
4521	abCDB[6] = 0; /* reserved */
4522	abCDB[7] = (tls >> 8) & 0xff;
4523	abCDB[8] = tls & 0xff;
4524	abCDB[9] = 0; /* control */
4525	}
4526	else
4527	{
4528	cbCDB = 16;
4529	abCDB[0] = SCSI_READ_16;
4530	abCDB[1] = 0; /* reserved */
4531	abCDB[2] = (lba >> 56) & 0xff;
4532	abCDB[3] = (lba >> 48) & 0xff;
4533	abCDB[4] = (lba >> 40) & 0xff;
4534	abCDB[5] = (lba >> 32) & 0xff;
4535	abCDB[6] = (lba >> 24) & 0xff;
4536	abCDB[7] = (lba >> 16) & 0xff;
4537	abCDB[8] = (lba >> 8) & 0xff;
4538	abCDB[9] = lba & 0xff;
4539	abCDB[10] = 0; /* tls unused */
4540	abCDB[11] = 0; /* tls unused */
4541	abCDB[12] = (tls >> 8) & 0xff;
4542	abCDB[13] = tls & 0xff;
4543	abCDB[14] = 0; /* reserved */
4544	abCDB[15] = 0; /* reserved */
4545	}
4546
4547	T2ISeg.pvSeg = pvBuf;
4548	T2ISeg.cbSeg = cbToRead;
4549
4550	sr.enmXfer = SCSIXFER_FROM_TARGET;
4551	sr.cbCDB = cbCDB;
4552	sr.pvCDB = abCDB;
4553	sr.cbI2TData = 0;
4554	sr.paI2TSegs = NULL;
4555	sr.cI2TSegs = 0;
4556	sr.cbT2IData = cbToRead;
4557	sr.paT2ISegs = &T2ISeg;
4558	sr.cT2ISegs = 1;
4559	sr.cbSense = sizeof(sense);
4560	sr.pvSense = sense;
4561
4562	rc = iscsiCommandSync(pImage, &sr, true, VERR_READ_ERROR);
4563	if (RT_FAILURE(rc))
4564	{
4565	LogFlow(("iscsiCommandSync(%s, %#llx) -> %Rrc\n", pImage->pszTargetName, uOffset, rc));
4566	*pcbActuallyRead = 0;
4567	}
4568	else
4569	*pcbActuallyRead = sr.cbT2IData;
4570
4571	out:
4572	LogFlowFunc(("returns %Rrc\n", rc));
4573	return rc;
4574	}
4575
4576	/** @copydoc VBOXHDDBACKEND::pfnWrite */
4577	static int iscsiWrite(void pBackendData, uint64_t uOffset, const void pvBuf,
4578	size_t cbToWrite, size_t *pcbWriteProcess,
4579	size_t pcbPreRead, size_t pcbPostRead, unsigned fWrite)
4580	{
4581	LogFlowFunc(("pBackendData=%#p uOffset=%llu pvBuf=%#p cbToWrite=%zu pcbWriteProcess=%#p pcbPreRead=%#p pcbPostRead=%#p\n", pBackendData, uOffset, pvBuf, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead));
4582	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4583	uint64_t lba;
4584	uint16_t tls;
4585	int rc;
4586
4587	Assert(pImage);
4588	Assert(uOffset % 512 == 0);
4589	Assert(cbToWrite % 512 == 0);
4590
4591	Assert(pImage->cbSector);
4592	Assert(pvBuf);
4593
4594	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
4595	{
4596	rc = VERR_VD_IMAGE_READ_ONLY;
4597	goto out;
4598	}
4599
4600	*pcbPreRead = 0;
4601	*pcbPostRead = 0;
4602
4603	/*
4604	* Clip write size to a value which is supported by the target.
4605	*/
4606	cbToWrite = RT_MIN(cbToWrite, pImage->cbSendDataLength);
4607
4608	lba = uOffset / pImage->cbSector;
4609	tls = (uint16_t)(cbToWrite / pImage->cbSector);
4610	SCSIREQ sr;
4611	RTSGSEG I2TSeg;
4612	size_t cbCDB;
4613	uint8_t abCDB[16];
4614	uint8_t sense[96];
4615
4616	if (pImage->cVolume < _4G)
4617	{
4618	cbCDB = 10;
4619	abCDB[0] = SCSI_WRITE_10;
4620	abCDB[1] = 0; /* reserved */
4621	abCDB[2] = (lba >> 24) & 0xff;
4622	abCDB[3] = (lba >> 16) & 0xff;
4623	abCDB[4] = (lba >> 8) & 0xff;
4624	abCDB[5] = lba & 0xff;
4625	abCDB[6] = 0; /* reserved */
4626	abCDB[7] = (tls >> 8) & 0xff;
4627	abCDB[8] = tls & 0xff;
4628	abCDB[9] = 0; /* control */
4629	}
4630	else
4631	{
4632	cbCDB = 16;
4633	abCDB[0] = SCSI_WRITE_16;
4634	abCDB[1] = 0; /* reserved */
4635	abCDB[2] = (lba >> 56) & 0xff;
4636	abCDB[3] = (lba >> 48) & 0xff;
4637	abCDB[4] = (lba >> 40) & 0xff;
4638	abCDB[5] = (lba >> 32) & 0xff;
4639	abCDB[6] = (lba >> 24) & 0xff;
4640	abCDB[7] = (lba >> 16) & 0xff;
4641	abCDB[8] = (lba >> 8) & 0xff;
4642	abCDB[9] = lba & 0xff;
4643	abCDB[10] = 0; /* tls unused */
4644	abCDB[11] = 0; /* tls unused */
4645	abCDB[12] = (tls >> 8) & 0xff;
4646	abCDB[13] = tls & 0xff;
4647	abCDB[14] = 0; /* reserved */
4648	abCDB[15] = 0; /* reserved */
4649	}
4650
4651	I2TSeg.pvSeg = (void *)pvBuf;
4652	I2TSeg.cbSeg = cbToWrite;
4653
4654	sr.enmXfer = SCSIXFER_TO_TARGET;
4655	sr.cbCDB = cbCDB;
4656	sr.pvCDB = abCDB;
4657	sr.cbI2TData = cbToWrite;
4658	sr.paI2TSegs = &I2TSeg;
4659	sr.cI2TSegs = 1;
4660	sr.cbT2IData = 0;
4661	sr.paT2ISegs = NULL;
4662	sr.cT2ISegs = 0;
4663	sr.cbSense = sizeof(sense);
4664	sr.pvSense = sense;
4665
4666	rc = iscsiCommandSync(pImage, &sr, true, VERR_WRITE_ERROR);
4667	if (RT_FAILURE(rc))
4668	{
4669	LogFlow(("iscsiCommandSync(%s, %#llx) -> %Rrc\n", pImage->pszTargetName, uOffset, rc));
4670	*pcbWriteProcess = 0;
4671	}
4672	else
4673	*pcbWriteProcess = cbToWrite;
4674
4675	out:
4676	LogFlowFunc(("returns %Rrc\n", rc));
4677	return rc;
4678	}
4679
4680	/** @copydoc VBOXHDDBACKEND::pfnFlush */
4681	static int iscsiFlush(void *pBackendData)
4682	{
4683	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
4684	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4685	int rc;
4686
4687	Assert(pImage);
4688
4689	SCSIREQ sr;
4690	uint8_t abCDB[10];
4691	uint8_t sense[96];
4692
4693	abCDB[0] = SCSI_SYNCHRONIZE_CACHE;
4694	abCDB[1] = 0; /* reserved */
4695	abCDB[2] = 0; /* LBA 0 */
4696	abCDB[3] = 0; /* LBA 0 */
4697	abCDB[4] = 0; /* LBA 0 */
4698	abCDB[5] = 0; /* LBA 0 */
4699	abCDB[6] = 0; /* reserved */
4700	abCDB[7] = 0; /* transfer everything to disk */
4701	abCDB[8] = 0; /* transfer everything to disk */
4702	abCDB[9] = 0; /* control */
4703
4704	sr.enmXfer = SCSIXFER_NONE;
4705	sr.cbCDB = sizeof(abCDB);
4706	sr.pvCDB = abCDB;
4707	sr.cbI2TData = 0;
4708	sr.paI2TSegs = NULL;
4709	sr.cI2TSegs = 0;
4710	sr.cbT2IData = 0;
4711	sr.paT2ISegs = NULL;
4712	sr.cT2ISegs = 0;
4713	sr.cbSense = sizeof(sense);
4714	sr.pvSense = sense;
4715
4716	rc = iscsiCommandSync(pImage, &sr, false, VINF_SUCCESS);
4717	if (RT_FAILURE(rc))
4718	AssertMsgFailed(("iscsiCommand(%s) -> %Rrc\n", pImage->pszTargetName, rc));
4719	LogFlowFunc(("returns %Rrc\n", rc));
4720	return rc;
4721	}
4722
4723	/** @copydoc VBOXHDDBACKEND::pfnGetVersion */
4724	static unsigned iscsiGetVersion(void *pBackendData)
4725	{
4726	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
4727	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4728
4729	Assert(pImage);
4730	NOREF(pImage);
4731
4732	return 0;
4733	}
4734
4735	/** @copydoc VBOXHDDBACKEND::pfnGetSize */
4736	static uint64_t iscsiGetSize(void *pBackendData)
4737	{
4738	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
4739	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4740
4741	Assert(pImage);
4742
4743	if (pImage)
4744	return pImage->cbSize;
4745	else
4746	return 0;
4747	}
4748
4749	/** @copydoc VBOXHDDBACKEND::pfnGetFileSize */
4750	static uint64_t iscsiGetFileSize(void *pBackendData)
4751	{
4752	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
4753	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4754
4755	Assert(pImage);
4756	NOREF(pImage);
4757
4758	if (pImage)
4759	return pImage->cbSize;
4760	else
4761	return 0;
4762	}
4763
4764	/** @copydoc VBOXHDDBACKEND::pfnGetPCHSGeometry */
4765	static int iscsiGetPCHSGeometry(void *pBackendData, PVDGEOMETRY pPCHSGeometry)
4766	{
4767	LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p\n", pBackendData, pPCHSGeometry));
4768	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4769	int rc;
4770
4771	Assert(pImage);
4772
4773	if (pImage)
4774	rc = VERR_VD_GEOMETRY_NOT_SET;
4775	else
4776	rc = VERR_VD_NOT_OPENED;
4777
4778	LogFlowFunc(("returns %Rrc (PCHS=%u/%u/%u)\n", rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
4779	return rc;
4780	}
4781
4782	/** @copydoc VBOXHDDBACKEND::pfnSetPCHSGeometry */
4783	static int iscsiSetPCHSGeometry(void *pBackendData, PCVDGEOMETRY pPCHSGeometry)
4784	{
4785	LogFlowFunc(("pBackendData=%#p pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pBackendData, pPCHSGeometry, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
4786	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4787	int rc;
4788
4789	Assert(pImage);
4790
4791	if (pImage)
4792	{
4793	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
4794	{
4795	rc = VERR_VD_IMAGE_READ_ONLY;
4796	goto out;
4797	}
4798	rc = VERR_VD_GEOMETRY_NOT_SET;
4799	}
4800	else
4801	rc = VERR_VD_NOT_OPENED;
4802
4803	out:
4804	LogFlowFunc(("returns %Rrc\n", rc));
4805	return rc;
4806	}
4807
4808	/** @copydoc VBOXHDDBACKEND::pfnGetLCHSGeometry */
4809	static int iscsiGetLCHSGeometry(void *pBackendData, PVDGEOMETRY pLCHSGeometry)
4810	{
4811	LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p\n", pBackendData, pLCHSGeometry));
4812	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4813	int rc;
4814
4815	Assert(pImage);
4816
4817	if (pImage)
4818	rc = VERR_VD_GEOMETRY_NOT_SET;
4819	else
4820	rc = VERR_VD_NOT_OPENED;
4821
4822	LogFlowFunc(("returns %Rrc (LCHS=%u/%u/%u)\n", rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
4823	return rc;
4824	}
4825
4826	/** @copydoc VBOXHDDBACKEND::pfnSetLCHSGeometry */
4827	static int iscsiSetLCHSGeometry(void *pBackendData, PCVDGEOMETRY pLCHSGeometry)
4828	{
4829	LogFlowFunc(("pBackendData=%#p pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pBackendData, pLCHSGeometry, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
4830	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4831	int rc;
4832
4833	Assert(pImage);
4834
4835	if (pImage)
4836	{
4837	if (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY)
4838	{
4839	rc = VERR_VD_IMAGE_READ_ONLY;
4840	goto out;
4841	}
4842	rc = VERR_VD_GEOMETRY_NOT_SET;
4843	}
4844	else
4845	rc = VERR_VD_NOT_OPENED;
4846
4847	out:
4848	LogFlowFunc(("returns %Rrc\n", rc));
4849	return rc;
4850	}
4851
4852	/** @copydoc VBOXHDDBACKEND::pfnGetImageFlags */
4853	static unsigned iscsiGetImageFlags(void *pBackendData)
4854	{
4855	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
4856	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4857	unsigned uImageFlags;
4858
4859	Assert(pImage);
4860	NOREF(pImage);
4861
4862	uImageFlags = VD_IMAGE_FLAGS_FIXED;
4863
4864	LogFlowFunc(("returns %#x\n", uImageFlags));
4865	return uImageFlags;
4866	}
4867
4868	/** @copydoc VBOXHDDBACKEND::pfnGetOpenFlags */
4869	static unsigned iscsiGetOpenFlags(void *pBackendData)
4870	{
4871	LogFlowFunc(("pBackendData=%#p\n", pBackendData));
4872	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4873	unsigned uOpenFlags;
4874
4875	Assert(pImage);
4876
4877	if (pImage)
4878	uOpenFlags = pImage->uOpenFlags;
4879	else
4880	uOpenFlags = 0;
4881
4882	LogFlowFunc(("returns %#x\n", uOpenFlags));
4883	return uOpenFlags;
4884	}
4885
4886	/** @copydoc VBOXHDDBACKEND::pfnSetOpenFlags */
4887	static int iscsiSetOpenFlags(void *pBackendData, unsigned uOpenFlags)
4888	{
4889	LogFlowFunc(("pBackendData=%#p\n uOpenFlags=%#x", pBackendData, uOpenFlags));
4890	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4891	int rc;
4892
4893	/* Image must be opened and the new flags must be valid. */
4894	if (!pImage \|\| (uOpenFlags & ~(VD_OPEN_FLAGS_READONLY \| VD_OPEN_FLAGS_INFO \| VD_OPEN_FLAGS_ASYNC_IO \| VD_OPEN_FLAGS_SHAREABLE \| VD_OPEN_FLAGS_SEQUENTIAL)))
4895	{
4896	rc = VERR_INVALID_PARAMETER;
4897	goto out;
4898	}
4899
4900	/* Implement this operation via reopening the image if we actually need
4901	* to do something. A read/write -> readonly transition doesn't need a
4902	* reopen. In the other direction we don't have the necessary information
4903	* as the "disk is readonly" flag is thrown away. Can be optimized too,
4904	* but it's not worth the effort at the moment. */
4905	if ( !(uOpenFlags & VD_OPEN_FLAGS_READONLY)
4906	&& (pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
4907	{
4908	iscsiFreeImage(pImage, false);
4909	rc = iscsiOpenImage(pImage, uOpenFlags);
4910	}
4911	else
4912	{
4913	pImage->uOpenFlags = uOpenFlags;
4914	rc = VINF_SUCCESS;
4915	}
4916	out:
4917	LogFlowFunc(("returns %Rrc\n", rc));
4918	return rc;
4919	}
4920
4921	/** @copydoc VBOXHDDBACKEND::pfnGetComment */
4922	static int iscsiGetComment(void pBackendData, char pszComment,
4923	size_t cbComment)
4924	{
4925	LogFlowFunc(("pBackendData=%#p pszComment=%#p cbComment=%zu\n", pBackendData, pszComment, cbComment));
4926	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4927	int rc;
4928
4929	Assert(pImage);
4930
4931	if (pImage)
4932	rc = VERR_NOT_SUPPORTED;
4933	else
4934	rc = VERR_VD_NOT_OPENED;
4935
4936	LogFlowFunc(("returns %Rrc comment='%s'\n", rc, pszComment));
4937	return rc;
4938	}
4939
4940	/** @copydoc VBOXHDDBACKEND::pfnSetComment */
4941	static int iscsiSetComment(void pBackendData, const char pszComment)
4942	{
4943	LogFlowFunc(("pBackendData=%#p pszComment=\"%s\"\n", pBackendData, pszComment));
4944	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4945	int rc;
4946
4947	Assert(pImage);
4948
4949	if (pImage)
4950	{
4951	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
4952	rc = VERR_NOT_SUPPORTED;
4953	else
4954	rc = VERR_VD_IMAGE_READ_ONLY;
4955	}
4956	else
4957	rc = VERR_VD_NOT_OPENED;
4958
4959	LogFlowFunc(("returns %Rrc\n", rc));
4960	return rc;
4961	}
4962
4963	/** @copydoc VBOXHDDBACKEND::pfnGetUuid */
4964	static int iscsiGetUuid(void *pBackendData, PRTUUID pUuid)
4965	{
4966	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
4967	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4968	int rc;
4969
4970	Assert(pImage);
4971
4972	if (pImage)
4973	rc = VERR_NOT_SUPPORTED;
4974	else
4975	rc = VERR_VD_NOT_OPENED;
4976
4977	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
4978	return rc;
4979	}
4980
4981	/** @copydoc VBOXHDDBACKEND::pfnSetUuid */
4982	static int iscsiSetUuid(void *pBackendData, PCRTUUID pUuid)
4983	{
4984	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
4985	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
4986	int rc;
4987
4988	LogFlowFunc(("%RTuuid\n", pUuid));
4989	Assert(pImage);
4990
4991	if (pImage)
4992	{
4993	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
4994	rc = VERR_NOT_SUPPORTED;
4995	else
4996	rc = VERR_VD_IMAGE_READ_ONLY;
4997	}
4998	else
4999	rc = VERR_VD_NOT_OPENED;
5000
5001	LogFlowFunc(("returns %Rrc\n", rc));
5002	return rc;
5003	}
5004
5005	/** @copydoc VBOXHDDBACKEND::pfnGetModificationUuid */
5006	static int iscsiGetModificationUuid(void *pBackendData, PRTUUID pUuid)
5007	{
5008	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
5009	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5010	int rc;
5011
5012	Assert(pImage);
5013
5014	if (pImage)
5015	rc = VERR_NOT_SUPPORTED;
5016	else
5017	rc = VERR_VD_NOT_OPENED;
5018
5019	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
5020	return rc;
5021	}
5022
5023	/** @copydoc VBOXHDDBACKEND::pfnSetModificationUuid */
5024	static int iscsiSetModificationUuid(void *pBackendData, PCRTUUID pUuid)
5025	{
5026	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
5027	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5028	int rc;
5029
5030	LogFlowFunc(("%RTuuid\n", pUuid));
5031	Assert(pImage);
5032
5033	if (pImage)
5034	{
5035	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
5036	rc = VERR_NOT_SUPPORTED;
5037	else
5038	rc = VERR_VD_IMAGE_READ_ONLY;
5039	}
5040	else
5041	rc = VERR_VD_NOT_OPENED;
5042
5043	LogFlowFunc(("returns %Rrc\n", rc));
5044	return rc;
5045	}
5046
5047	/** @copydoc VBOXHDDBACKEND::pfnGetParentUuid */
5048	static int iscsiGetParentUuid(void *pBackendData, PRTUUID pUuid)
5049	{
5050	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
5051	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5052	int rc;
5053
5054	Assert(pImage);
5055
5056	if (pImage)
5057	rc = VERR_NOT_SUPPORTED;
5058	else
5059	rc = VERR_VD_NOT_OPENED;
5060
5061	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
5062	return rc;
5063	}
5064
5065	/** @copydoc VBOXHDDBACKEND::pfnSetParentUuid */
5066	static int iscsiSetParentUuid(void *pBackendData, PCRTUUID pUuid)
5067	{
5068	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
5069	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5070	int rc;
5071
5072	LogFlowFunc(("%RTuuid\n", pUuid));
5073	Assert(pImage);
5074
5075	if (pImage)
5076	{
5077	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
5078	rc = VERR_NOT_SUPPORTED;
5079	else
5080	rc = VERR_VD_IMAGE_READ_ONLY;
5081	}
5082	else
5083	rc = VERR_VD_NOT_OPENED;
5084
5085	LogFlowFunc(("returns %Rrc\n", rc));
5086	return rc;
5087	}
5088
5089	/** @copydoc VBOXHDDBACKEND::pfnGetParentModificationUuid */
5090	static int iscsiGetParentModificationUuid(void *pBackendData, PRTUUID pUuid)
5091	{
5092	LogFlowFunc(("pBackendData=%#p pUuid=%#p\n", pBackendData, pUuid));
5093	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5094	int rc;
5095
5096	Assert(pImage);
5097
5098	if (pImage)
5099	rc = VERR_NOT_SUPPORTED;
5100	else
5101	rc = VERR_VD_NOT_OPENED;
5102
5103	LogFlowFunc(("returns %Rrc (%RTuuid)\n", rc, pUuid));
5104	return rc;
5105	}
5106
5107	/** @copydoc VBOXHDDBACKEND::pfnSetParentModificationUuid */
5108	static int iscsiSetParentModificationUuid(void *pBackendData, PCRTUUID pUuid)
5109	{
5110	LogFlowFunc(("pBackendData=%#p Uuid=%RTuuid\n", pBackendData, pUuid));
5111	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5112	int rc;
5113
5114	LogFlowFunc(("%RTuuid\n", pUuid));
5115	Assert(pImage);
5116
5117	if (pImage)
5118	{
5119	if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_READONLY))
5120	rc = VERR_NOT_SUPPORTED;
5121	else
5122	rc = VERR_VD_IMAGE_READ_ONLY;
5123	}
5124	else
5125	rc = VERR_VD_NOT_OPENED;
5126
5127	LogFlowFunc(("returns %Rrc\n", rc));
5128	return rc;
5129	}
5130
5131	/** @copydoc VBOXHDDBACKEND::pfnDump */
5132	static void iscsiDump(void *pBackendData)
5133	{
5134	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5135
5136	Assert(pImage);
5137	if (pImage)
5138	{
5139	/** @todo put something useful here */
5140	iscsiMessage(pImage, "Header: cVolume=%u\n", pImage->cVolume);
5141	}
5142	}
5143
5144	/** @copydoc VBOXHDDBACKEND::pfnIsAsyncIOSupported */
5145	static bool iscsiIsAsyncIOSupported(void *pBackendData)
5146	{
5147	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5148	return pImage->fCmdQueuingSupported;
5149	}
5150
5151	/** @copydoc VBOXHDDBACKEND::pfnAsyncRead */
5152	static int iscsiAsyncRead(void *pBackendData, uint64_t uOffset, size_t cbToRead,
5153	PVDIOCTX pIoCtx, size_t *pcbActuallyRead)
5154	{
5155	LogFlowFunc(("pBackendData=%p uOffset=%#llx pIoCtx=%#p cbToRead=%u pcbActuallyRead=%p\n",
5156	pBackendData, uOffset, pIoCtx, cbToRead, pcbActuallyRead));
5157	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5158	int rc = VINF_SUCCESS;
5159
5160	if (uOffset + cbToRead > pImage->cbSize)
5161	return VERR_INVALID_PARAMETER;
5162
5163	/*
5164	* Clip read size to a value which is supported by the target.
5165	*/
5166	cbToRead = RT_MIN(cbToRead, pImage->cbRecvDataLength);
5167
5168	unsigned cT2ISegs = 0;
5169	size_t cbSegs = 0;
5170
5171	/* Get the number of segments. */
5172	cbSegs = pImage->pInterfaceIoCallbacks->pfnIoCtxSegArrayCreate(pImage->pInterfaceIo->pvUser, pIoCtx,
5173	NULL, &cT2ISegs, cbToRead);
5174	Assert(cbSegs == cbToRead);
5175
5176	PSCSIREQASYNC pReqAsync = (PSCSIREQASYNC)RTMemAllocZ(RT_OFFSETOF(SCSIREQASYNC, aSegs[cT2ISegs]));
5177	if (RT_LIKELY(pReqAsync))
5178	{
5179	PSCSIREQ pReq = (PSCSIREQ)RTMemAllocZ(sizeof(SCSIREQ));
5180	if (pReq)
5181	{
5182	uint64_t lba;
5183	uint16_t tls;
5184	uint8_t *pbCDB = &pReqAsync->abCDB[0];
5185	size_t cbCDB;
5186
5187	lba = uOffset / pImage->cbSector;
5188	tls = (uint16_t)(cbToRead / pImage->cbSector);
5189
5190	cbSegs = pImage->pInterfaceIoCallbacks->pfnIoCtxSegArrayCreate(pImage->pInterfaceIo->pvUser, pIoCtx,
5191	&pReqAsync->aSegs[0],
5192	&cT2ISegs, cbToRead);
5193	Assert(cbSegs == cbToRead);
5194	pReqAsync->cT2ISegs = cT2ISegs;
5195	pReqAsync->pIoCtx = pIoCtx;
5196	pReqAsync->pScsiReq = pReq;
5197	pReqAsync->cSenseRetries = 10;
5198	pReqAsync->rcSense = VERR_READ_ERROR;
5199
5200	if (pImage->cVolume < _4G)
5201	{
5202	cbCDB = 10;
5203	pbCDB[0] = SCSI_READ_10;
5204	pbCDB[1] = 0; /* reserved */
5205	pbCDB[2] = (lba >> 24) & 0xff;
5206	pbCDB[3] = (lba >> 16) & 0xff;
5207	pbCDB[4] = (lba >> 8) & 0xff;
5208	pbCDB[5] = lba & 0xff;
5209	pbCDB[6] = 0; /* reserved */
5210	pbCDB[7] = (tls >> 8) & 0xff;
5211	pbCDB[8] = tls & 0xff;
5212	pbCDB[9] = 0; /* control */
5213	}
5214	else
5215	{
5216	cbCDB = 16;
5217	pbCDB[0] = SCSI_READ_16;
5218	pbCDB[1] = 0; /* reserved */
5219	pbCDB[2] = (lba >> 56) & 0xff;
5220	pbCDB[3] = (lba >> 48) & 0xff;
5221	pbCDB[4] = (lba >> 40) & 0xff;
5222	pbCDB[5] = (lba >> 32) & 0xff;
5223	pbCDB[6] = (lba >> 24) & 0xff;
5224	pbCDB[7] = (lba >> 16) & 0xff;
5225	pbCDB[8] = (lba >> 8) & 0xff;
5226	pbCDB[9] = lba & 0xff;
5227	pbCDB[10] = 0; /* tls unused */
5228	pbCDB[11] = 0; /* tls unused */
5229	pbCDB[12] = (tls >> 8) & 0xff;
5230	pbCDB[13] = tls & 0xff;
5231	pbCDB[14] = 0; /* reserved */
5232	pbCDB[15] = 0; /* reserved */
5233	}
5234
5235	pReq->enmXfer = SCSIXFER_FROM_TARGET;
5236	pReq->cbCDB = cbCDB;
5237	pReq->pvCDB = pReqAsync->abCDB;
5238	pReq->cbI2TData = 0;
5239	pReq->paI2TSegs = NULL;
5240	pReq->cI2TSegs = 0;
5241	pReq->cbT2IData = cbToRead;
5242	pReq->paT2ISegs = &pReqAsync->aSegs[pReqAsync->cI2TSegs];
5243	pReq->cT2ISegs = pReqAsync->cT2ISegs;
5244	pReq->cbSense = sizeof(pReqAsync->abSense);
5245	pReq->pvSense = pReqAsync->abSense;
5246
5247	rc = iscsiCommandAsync(pImage, pReq, iscsiCommandAsyncComplete, pReqAsync);
5248	if (RT_FAILURE(rc))
5249	AssertMsgFailed(("iscsiCommand(%s, %#llx) -> %Rrc\n", pImage->pszTargetName, uOffset, rc));
5250	else
5251	{
5252	*pcbActuallyRead = cbToRead;
5253	return VERR_VD_IOCTX_HALT; /* Halt the I/O context until further notification from the I/O thread. */
5254	}
5255
5256	RTMemFree(pReq);
5257	}
5258	else
5259	rc = VERR_NO_MEMORY;
5260
5261	RTMemFree(pReqAsync);
5262	}
5263	else
5264	rc = VERR_NO_MEMORY;
5265
5266	LogFlowFunc(("returns rc=%Rrc\n", rc));
5267	return rc;
5268	}
5269
5270	/** @copydoc VBOXHDDBACKEND::pfnAsyncWrite */
5271	static int iscsiAsyncWrite(void *pBackendData, uint64_t uOffset, size_t cbToWrite,
5272	PVDIOCTX pIoCtx,
5273	size_t pcbWriteProcess, size_t pcbPreRead,
5274	size_t *pcbPostRead, unsigned fWrite)
5275	{
5276	LogFlowFunc(("pBackendData=%p uOffset=%llu pIoCtx=%#p cbToWrite=%u pcbWriteProcess=%p pcbPreRead=%p pcbPostRead=%p fWrite=%u\n",
5277	pBackendData, uOffset, pIoCtx, cbToWrite, pcbWriteProcess, pcbPreRead, pcbPostRead, fWrite));
5278	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5279	int rc = VINF_SUCCESS;
5280
5281	AssertPtr(pImage);
5282	Assert(uOffset % 512 == 0);
5283	Assert(cbToWrite % 512 == 0);
5284
5285	if (uOffset + cbToWrite > pImage->cbSize)
5286	return VERR_INVALID_PARAMETER;
5287
5288	/*
5289	* Clip read size to a value which is supported by the target.
5290	*/
5291	cbToWrite = RT_MIN(cbToWrite, pImage->cbSendDataLength);
5292
5293	unsigned cI2TSegs = 0;
5294	size_t cbSegs = 0;
5295
5296	/* Get the number of segments. */
5297	cbSegs = pImage->pInterfaceIoCallbacks->pfnIoCtxSegArrayCreate(pImage->pInterfaceIo->pvUser, pIoCtx,
5298	NULL, &cI2TSegs, cbToWrite);
5299	Assert(cbSegs == cbToWrite);
5300
5301	PSCSIREQASYNC pReqAsync = (PSCSIREQASYNC)RTMemAllocZ(RT_OFFSETOF(SCSIREQASYNC, aSegs[cI2TSegs]));
5302	if (RT_LIKELY(pReqAsync))
5303	{
5304	PSCSIREQ pReq = (PSCSIREQ)RTMemAllocZ(sizeof(SCSIREQ));
5305	if (pReq)
5306	{
5307	uint64_t lba;
5308	uint16_t tls;
5309	uint8_t *pbCDB = &pReqAsync->abCDB[0];
5310	size_t cbCDB;
5311
5312	lba = uOffset / pImage->cbSector;
5313	tls = (uint16_t)(cbToWrite / pImage->cbSector);
5314
5315	cbSegs = pImage->pInterfaceIoCallbacks->pfnIoCtxSegArrayCreate(pImage->pInterfaceIo->pvUser, pIoCtx,
5316	&pReqAsync->aSegs[0],
5317	&cI2TSegs, cbToWrite);
5318	Assert(cbSegs == cbToWrite);
5319	pReqAsync->cI2TSegs = cI2TSegs;
5320	pReqAsync->pIoCtx = pIoCtx;
5321	pReqAsync->pScsiReq = pReq;
5322	pReqAsync->cSenseRetries = 10;
5323	pReqAsync->rcSense = VERR_WRITE_ERROR;
5324
5325	if (pImage->cVolume < _4G)
5326	{
5327	cbCDB = 10;
5328	pbCDB[0] = SCSI_WRITE_10;
5329	pbCDB[1] = 0; /* reserved */
5330	pbCDB[2] = (lba >> 24) & 0xff;
5331	pbCDB[3] = (lba >> 16) & 0xff;
5332	pbCDB[4] = (lba >> 8) & 0xff;
5333	pbCDB[5] = lba & 0xff;
5334	pbCDB[6] = 0; /* reserved */
5335	pbCDB[7] = (tls >> 8) & 0xff;
5336	pbCDB[8] = tls & 0xff;
5337	pbCDB[9] = 0; /* control */
5338	}
5339	else
5340	{
5341	cbCDB = 16;
5342	pbCDB[0] = SCSI_WRITE_16;
5343	pbCDB[1] = 0; /* reserved */
5344	pbCDB[2] = (lba >> 56) & 0xff;
5345	pbCDB[3] = (lba >> 48) & 0xff;
5346	pbCDB[4] = (lba >> 40) & 0xff;
5347	pbCDB[5] = (lba >> 32) & 0xff;
5348	pbCDB[6] = (lba >> 24) & 0xff;
5349	pbCDB[7] = (lba >> 16) & 0xff;
5350	pbCDB[8] = (lba >> 8) & 0xff;
5351	pbCDB[9] = lba & 0xff;
5352	pbCDB[10] = 0; /* tls unused */
5353	pbCDB[11] = 0; /* tls unused */
5354	pbCDB[12] = (tls >> 8) & 0xff;
5355	pbCDB[13] = tls & 0xff;
5356	pbCDB[14] = 0; /* reserved */
5357	pbCDB[15] = 0; /* reserved */
5358	}
5359
5360	pReq->enmXfer = SCSIXFER_TO_TARGET;
5361	pReq->cbCDB = cbCDB;
5362	pReq->pvCDB = pReqAsync->abCDB;
5363	pReq->cbI2TData = cbToWrite;
5364	pReq->paI2TSegs = &pReqAsync->aSegs[0];
5365	pReq->cI2TSegs = pReqAsync->cI2TSegs;
5366	pReq->cbT2IData = 0;
5367	pReq->paT2ISegs = NULL;
5368	pReq->cT2ISegs = 0;
5369	pReq->cbSense = sizeof(pReqAsync->abSense);
5370	pReq->pvSense = pReqAsync->abSense;
5371
5372	rc = iscsiCommandAsync(pImage, pReq, iscsiCommandAsyncComplete, pReqAsync);
5373	if (RT_FAILURE(rc))
5374	AssertMsgFailed(("iscsiCommand(%s, %#llx) -> %Rrc\n", pImage->pszTargetName, uOffset, rc));
5375	else
5376	{
5377	*pcbWriteProcess = cbToWrite;
5378	return VERR_VD_IOCTX_HALT; /* Halt the I/O context until further notification from the I/O thread. */
5379	}
5380
5381	RTMemFree(pReq);
5382	}
5383	else
5384	rc = VERR_NO_MEMORY;
5385
5386	RTMemFree(pReqAsync);
5387	}
5388	else
5389	rc = VERR_NO_MEMORY;
5390
5391	LogFlowFunc(("returns rc=%Rrc\n", rc));
5392	return rc;
5393	}
5394
5395	/** @copydoc VBOXHDDBACKEND::pfnAsyncFlush */
5396	static int iscsiAsyncFlush(void *pBackendData, PVDIOCTX pIoCtx)
5397	{
5398	LogFlowFunc(("pBackendData=%p pIoCtx=%#p\n", pBackendData, pIoCtx));
5399	PISCSIIMAGE pImage = (PISCSIIMAGE)pBackendData;
5400	int rc = VINF_SUCCESS;
5401
5402	PSCSIREQASYNC pReqAsync = (PSCSIREQASYNC)RTMemAllocZ(sizeof(SCSIREQASYNC));
5403	if (RT_LIKELY(pReqAsync))
5404	{
5405	PSCSIREQ pReq = (PSCSIREQ)RTMemAllocZ(sizeof(SCSIREQ));
5406	if (pReq)
5407	{
5408	uint8_t *pbCDB = &pReqAsync->abCDB[0];
5409
5410	pReqAsync->pIoCtx = pIoCtx;
5411	pReqAsync->pScsiReq = pReq;
5412	pReqAsync->cSenseRetries = 0;
5413	pReqAsync->rcSense = VINF_SUCCESS;
5414
5415	pbCDB[0] = SCSI_SYNCHRONIZE_CACHE;
5416	pbCDB[1] = 0; /* reserved */
5417	pbCDB[2] = 0; /* reserved */
5418	pbCDB[3] = 0; /* reserved */
5419	pbCDB[4] = 0; /* reserved */
5420	pbCDB[5] = 0; /* reserved */
5421	pbCDB[6] = 0; /* reserved */
5422	pbCDB[7] = 0; /* reserved */
5423	pbCDB[8] = 0; /* reserved */
5424	pbCDB[9] = 0; /* control */
5425
5426	pReq->enmXfer = SCSIXFER_NONE;
5427	pReq->cbCDB = 10;
5428	pReq->pvCDB = pReqAsync->abCDB;
5429	pReq->cbI2TData = 0;
5430	pReq->paI2TSegs = NULL;
5431	pReq->cI2TSegs = 0;
5432	pReq->cbT2IData = 0;
5433	pReq->paT2ISegs = NULL;
5434	pReq->cT2ISegs = 0;
5435	pReq->cbSense = sizeof(pReqAsync->abSense);
5436	pReq->pvSense = pReqAsync->abSense;
5437
5438	rc = iscsiCommandAsync(pImage, pReq, iscsiCommandAsyncComplete, pReqAsync);
5439	if (RT_FAILURE(rc))
5440	AssertMsgFailed(("iscsiCommand(%s) -> %Rrc\n", pImage->pszTargetName, rc));
5441	else
5442	return VERR_VD_IOCTX_HALT; /* Halt the I/O context until further notification from the I/O thread. */
5443
5444	RTMemFree(pReq);
5445	}
5446	else
5447	rc = VERR_NO_MEMORY;
5448
5449	RTMemFree(pReqAsync);
5450	}
5451	else
5452	rc = VERR_NO_MEMORY;
5453
5454	LogFlowFunc(("returns rc=%Rrc\n", rc));
5455	return rc;
5456	}
5457
5458	/** @copydoc VBOXHDDBACKEND::pfnComposeLocation */
5459	static int iscsiComposeLocation(PVDINTERFACE pConfig, char **pszLocation)
5460	{
5461	char *pszTarget = NULL;
5462	char *pszLUN = NULL;
5463	char *pszAddress = NULL;
5464	int rc = VDCFGQueryStringAlloc(VDGetInterfaceConfig(pConfig), pConfig->pvUser, "TargetName", &pszTarget);
5465	if (RT_SUCCESS(rc))
5466	{
5467	rc = VDCFGQueryStringAlloc(VDGetInterfaceConfig(pConfig), pConfig->pvUser, "LUN", &pszLUN);
5468	if (RT_SUCCESS(rc))
5469	{
5470	rc = VDCFGQueryStringAlloc(VDGetInterfaceConfig(pConfig), pConfig->pvUser, "TargetAddress", &pszAddress);
5471	if (RT_SUCCESS(rc))
5472	{
5473	if (RTStrAPrintf(pszLocation, "iscsi://%s/%s/%s",
5474	pszAddress, pszTarget, pszLUN) < 0)
5475	rc = VERR_NO_MEMORY;
5476	}
5477	}
5478	}
5479	RTMemFree(pszTarget);
5480	RTMemFree(pszLUN);
5481	RTMemFree(pszAddress);
5482	return rc;
5483	}
5484
5485	/** @copydoc VBOXHDDBACKEND::pfnComposeName */
5486	static int iscsiComposeName(PVDINTERFACE pConfig, char **pszName)
5487	{
5488	char *pszTarget = NULL;
5489	char *pszLUN = NULL;
5490	char *pszAddress = NULL;
5491	int rc = VDCFGQueryStringAlloc(VDGetInterfaceConfig(pConfig), pConfig->pvUser, "TargetName", &pszTarget);
5492	if (RT_SUCCESS(rc))
5493	{
5494	rc = VDCFGQueryStringAlloc(VDGetInterfaceConfig(pConfig), pConfig->pvUser, "LUN", &pszLUN);
5495	if (RT_SUCCESS(rc))
5496	{
5497	rc = VDCFGQueryStringAlloc(VDGetInterfaceConfig(pConfig), pConfig->pvUser, "TargetAddress", &pszAddress);
5498	if (RT_SUCCESS(rc))
5499	{
5500	/** @todo think about a nicer looking location scheme for iSCSI */
5501	if (RTStrAPrintf(pszName, "%s/%s/%s",
5502	pszAddress, pszTarget, pszLUN) < 0)
5503	rc = VERR_NO_MEMORY;
5504	}
5505	}
5506	}
5507	RTMemFree(pszTarget);
5508	RTMemFree(pszLUN);
5509	RTMemFree(pszAddress);
5510
5511	return rc;
5512	}
5513
5514
5515	VBOXHDDBACKEND g_ISCSIBackend =
5516	{
5517	/* pszBackendName */
5518	"iSCSI",
5519	/* cbSize */
5520	sizeof(VBOXHDDBACKEND),
5521	/* uBackendCaps */
5522	VD_CAP_CONFIG \| VD_CAP_TCPNET \| VD_CAP_ASYNC,
5523	/* papszFileExtensions */
5524	NULL,
5525	/* paConfigInfo */
5526	s_iscsiConfigInfo,
5527	/* hPlugin */
5528	NIL_RTLDRMOD,
5529	/* pfnCheckIfValid */
5530	iscsiCheckIfValid,
5531	/* pfnOpen */
5532	iscsiOpen,
5533	/* pfnCreate */
5534	iscsiCreate,
5535	/* pfnRename */
5536	NULL,
5537	/* pfnClose */
5538	iscsiClose,
5539	/* pfnRead */
5540	iscsiRead,
5541	/* pfnWrite */
5542	iscsiWrite,
5543	/* pfnFlush */
5544	iscsiFlush,
5545	/* pfnGetVersion */
5546	iscsiGetVersion,
5547	/* pfnGetSize */
5548	iscsiGetSize,
5549	/* pfnGetFileSize */
5550	iscsiGetFileSize,
5551	/* pfnGetPCHSGeometry */
5552	iscsiGetPCHSGeometry,
5553	/* pfnSetPCHSGeometry */
5554	iscsiSetPCHSGeometry,
5555	/* pfnGetLCHSGeometry */
5556	iscsiGetLCHSGeometry,
5557	/* pfnSetLCHSGeometry */
5558	iscsiSetLCHSGeometry,
5559	/* pfnGetImageFlags */
5560	iscsiGetImageFlags,
5561	/* pfnGetOpenFlags */
5562	iscsiGetOpenFlags,
5563	/* pfnSetOpenFlags */
5564	iscsiSetOpenFlags,
5565	/* pfnGetComment */
5566	iscsiGetComment,
5567	/* pfnSetComment */
5568	iscsiSetComment,
5569	/* pfnGetUuid */
5570	iscsiGetUuid,
5571	/* pfnSetUuid */
5572	iscsiSetUuid,
5573	/* pfnGetModificationUuid */
5574	iscsiGetModificationUuid,
5575	/* pfnSetModificationUuid */
5576	iscsiSetModificationUuid,
5577	/* pfnGetParentUuid */
5578	iscsiGetParentUuid,
5579	/* pfnSetParentUuid */
5580	iscsiSetParentUuid,
5581	/* pfnGetParentModificationUuid */
5582	iscsiGetParentModificationUuid,
5583	/* pfnSetParentModificationUuid */
5584	iscsiSetParentModificationUuid,
5585	/* pfnDump */
5586	iscsiDump,
5587	/* pfnGetTimeStamp */
5588	NULL,
5589	/* pfnGetParentTimeStamp */
5590	NULL,
5591	/* pfnSetParentTimeStamp */
5592	NULL,
5593	/* pfnGetParentFilename */
5594	NULL,
5595	/* pfnSetParentFilename */
5596	NULL,
5597	/* pfnIsAsyncIOSupported */
5598	iscsiIsAsyncIOSupported,
5599	/* pfnAsyncRead */
5600	iscsiAsyncRead,
5601	/* pfnAsyncWrite */
5602	iscsiAsyncWrite,
5603	/* pfnAsyncFlush */
5604	iscsiAsyncFlush,
5605	/* pfnComposeLocation */
5606	iscsiComposeLocation,
5607	/* pfnComposeName */
5608	iscsiComposeName,
5609	/* pfnCompact */
5610	NULL,
5611	/* pfnResize */
5612	NULL
5613	};

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Storage/ISCSI.cpp@ 34906

Download in other formats: