VirtualBox

source: vbox/trunk/src/VBox/Devices/Storage/VSCSI/VSCSIDevice.cpp@ 44392

Last change on this file since 44392 was 43687, checked in by vboxsync, 12 years ago

VSCSI: Missing break
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.3 KB
Line 
1/* $Id: VSCSIDevice.cpp 43687 2012-10-18 17:45:35Z vboxsync $ */
2/** @file
3 * Virtual SCSI driver: Device handling
4 */
5
6/*
7 * Copyright (C) 2006-2011 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* Header Files *
19*******************************************************************************/
20#define LOG_GROUP LOG_GROUP_VSCSI
21#include <VBox/log.h>
22#include <VBox/err.h>
23#include <VBox/types.h>
24#include <VBox/vscsi.h>
25#include <iprt/assert.h>
26#include <iprt/mem.h>
27#include <iprt/string.h>
28
29#include "VSCSIInternal.h"
30
31/**
32 * Checks if a specific LUN exists fir the SCSI device
33 *
34 * @returns true if the LUN is present
35 * false otherwise
36 * @param pVScsiDevice The SCSI device instance.
37 * @param iLun The LUN to check for.
38 */
39DECLINLINE(bool) vscsiDeviceLunIsPresent(PVSCSIDEVICEINT pVScsiDevice, uint32_t iLun)
40{
41 return ( iLun < pVScsiDevice->cLunsMax
42 && pVScsiDevice->papVScsiLun[iLun] != NULL);
43}
44
45/**
46 * Process a request common for all device types.
47 *
48 * @returns Flag whether we could handle the request.
49 * @param pVScsiDevice The virtual SCSI device instance.
50 * @param pVScsiReq The SCSi request.
51 * @param prcReq The final return value if the request was handled.
52 */
53static bool vscsiDeviceReqProcess(PVSCSIDEVICEINT pVScsiDevice, PVSCSIREQINT pVScsiReq,
54 int *prcReq)
55{
56 bool fProcessed = true;
57
58 switch (pVScsiReq->pbCDB[0])
59 {
60 case SCSI_INQUIRY:
61 {
62 if (!vscsiDeviceLunIsPresent(pVScsiDevice, pVScsiReq->iLun))
63 {
64 size_t cbData;
65 SCSIINQUIRYDATA ScsiInquiryReply;
66
67 memset(&ScsiInquiryReply, 0, sizeof(ScsiInquiryReply));
68 ScsiInquiryReply.cbAdditional = 31;
69 ScsiInquiryReply.u5PeripheralDeviceType = SCSI_INQUIRY_DATA_PERIPHERAL_DEVICE_TYPE_UNKNOWN;
70 ScsiInquiryReply.u3PeripheralQualifier = SCSI_INQUIRY_DATA_PERIPHERAL_QUALIFIER_NOT_CONNECTED_NOT_SUPPORTED;
71 cbData = RTSgBufCopyFromBuf(&pVScsiReq->SgBuf, (uint8_t *)&ScsiInquiryReply, sizeof(SCSIINQUIRYDATA));
72 *prcReq = vscsiReqSenseOkSet(&pVScsiDevice->VScsiSense, pVScsiReq);
73 }
74 else
75 fProcessed = false; /* Let the LUN process the request because it will provide LUN specific data */
76
77 break;
78 }
79 case SCSI_REPORT_LUNS:
80 {
81 /*
82 * If allocation length is less than 16 bytes SPC compliant devices have
83 * to return an error.
84 */
85 if (vscsiBE2HU32(&pVScsiReq->pbCDB[6]) < 16)
86 *prcReq = vscsiReqSenseErrorSet(&pVScsiDevice->VScsiSense, pVScsiReq, SCSI_SENSE_ILLEGAL_REQUEST, SCSI_ASC_INV_FIELD_IN_CMD_PACKET, 0x00);
87 else
88 {
89 size_t cbData;
90 uint8_t aReply[16]; /* We report only one LUN. */
91
92 memset(aReply, 0, sizeof(aReply));
93 vscsiH2BEU32(&aReply[0], 8); /* List length starts at position 0. */
94 cbData = RTSgBufCopyFromBuf(&pVScsiReq->SgBuf, aReply, sizeof(aReply));
95 if (cbData < 16)
96 *prcReq = vscsiReqSenseErrorSet(&pVScsiDevice->VScsiSense, pVScsiReq, SCSI_SENSE_ILLEGAL_REQUEST, SCSI_ASC_INV_FIELD_IN_CMD_PACKET, 0x00);
97 else
98 *prcReq = vscsiReqSenseOkSet(&pVScsiDevice->VScsiSense, pVScsiReq);
99 }
100 break;
101 }
102 case SCSI_TEST_UNIT_READY:
103 {
104 if (pVScsiDevice->papVScsiLun[pVScsiReq->iLun]->fReady)
105 *prcReq = vscsiReqSenseOkSet(&pVScsiDevice->VScsiSense, pVScsiReq);
106 else
107 fProcessed = false; /* The LUN will provide details. */
108 break;
109 }
110 case SCSI_REQUEST_SENSE:
111 {
112 /* Descriptor format sense data is not supported and results in an error. */
113 if ((pVScsiReq->pbCDB[1] & 0x1) != 0)
114 *prcReq = vscsiReqSenseErrorSet(&pVScsiDevice->VScsiSense, pVScsiReq, SCSI_SENSE_ILLEGAL_REQUEST, SCSI_ASC_INV_FIELD_IN_CMD_PACKET, 0x00);
115 else
116 *prcReq = vscsiReqSenseCmd(&pVScsiDevice->VScsiSense, pVScsiReq);
117 break;
118 }
119 default:
120 fProcessed = false;
121 }
122
123 return fProcessed;
124}
125
126
127void vscsiDeviceReqComplete(PVSCSIDEVICEINT pVScsiDevice, PVSCSIREQINT pVScsiReq,
128 int rcScsiCode, bool fRedoPossible, int rcReq)
129{
130 pVScsiDevice->pfnVScsiReqCompleted(pVScsiDevice, pVScsiDevice->pvVScsiDeviceUser,
131 pVScsiReq->pvVScsiReqUser, rcScsiCode, fRedoPossible,
132 rcReq);
133
134 RTMemCacheFree(pVScsiDevice->hCacheReq, pVScsiReq);
135}
136
137
138VBOXDDU_DECL(int) VSCSIDeviceCreate(PVSCSIDEVICE phVScsiDevice,
139 PFNVSCSIREQCOMPLETED pfnVScsiReqCompleted,
140 void *pvVScsiDeviceUser)
141{
142 int rc = VINF_SUCCESS;
143 PVSCSIDEVICEINT pVScsiDevice = NULL;
144
145 AssertPtrReturn(phVScsiDevice, VERR_INVALID_POINTER);
146 AssertPtrReturn(pfnVScsiReqCompleted, VERR_INVALID_POINTER);
147
148 pVScsiDevice = (PVSCSIDEVICEINT)RTMemAllocZ(sizeof(VSCSIDEVICEINT));
149 if (!pVScsiDevice)
150 return VERR_NO_MEMORY;
151
152 pVScsiDevice->pfnVScsiReqCompleted = pfnVScsiReqCompleted;
153 pVScsiDevice->pvVScsiDeviceUser = pvVScsiDeviceUser;
154 pVScsiDevice->cLunsAttached = 0;
155 pVScsiDevice->cLunsMax = 0;
156 pVScsiDevice->papVScsiLun = NULL;
157 vscsiSenseInit(&pVScsiDevice->VScsiSense);
158
159 rc = RTMemCacheCreate(&pVScsiDevice->hCacheReq, sizeof(VSCSIREQINT), 0, UINT32_MAX,
160 NULL, NULL, NULL, 0);
161 if (RT_SUCCESS(rc))
162 {
163 *phVScsiDevice = pVScsiDevice;
164 LogFlow(("%s: hVScsiDevice=%#p -> VINF_SUCCESS\n", __FUNCTION__, pVScsiDevice));
165 return VINF_SUCCESS;
166 }
167
168 RTMemFree(pVScsiDevice);
169
170 return rc;
171}
172
173
174VBOXDDU_DECL(int) VSCSIDeviceDestroy(VSCSIDEVICE hVScsiDevice)
175{
176 AssertPtrReturn(hVScsiDevice, VERR_INVALID_HANDLE);
177
178 PVSCSIDEVICEINT pVScsiDevice = (PVSCSIDEVICEINT)hVScsiDevice;
179
180 if (pVScsiDevice->cLunsAttached > 0)
181 return VERR_VSCSI_LUN_ATTACHED_TO_DEVICE;
182
183 if (pVScsiDevice->papVScsiLun)
184 RTMemFree(pVScsiDevice->papVScsiLun);
185
186 RTMemCacheDestroy(pVScsiDevice->hCacheReq);
187 RTMemFree(pVScsiDevice);
188
189 return VINF_SUCCESS;;
190}
191
192
193VBOXDDU_DECL(int) VSCSIDeviceLunAttach(VSCSIDEVICE hVScsiDevice, VSCSILUN hVScsiLun, uint32_t iLun)
194{
195 PVSCSIDEVICEINT pVScsiDevice = (PVSCSIDEVICEINT)hVScsiDevice;
196 PVSCSILUNINT pVScsiLun = (PVSCSILUNINT)hVScsiLun;
197 int rc = VINF_SUCCESS;
198
199 /* Parameter checks */
200 AssertPtrReturn(pVScsiDevice, VERR_INVALID_HANDLE);
201 AssertPtrReturn(pVScsiLun, VERR_INVALID_HANDLE);
202 AssertReturn(iLun < VSCSI_DEVICE_LUN_MAX, VERR_VSCSI_LUN_INVALID);
203 AssertReturn(!pVScsiLun->pVScsiDevice, VERR_VSCSI_LUN_ATTACHED_TO_DEVICE);
204
205 if (iLun >= pVScsiDevice->cLunsMax)
206 {
207 PPVSCSILUNINT papLunOld = pVScsiDevice->papVScsiLun;
208
209 pVScsiDevice->papVScsiLun = (PPVSCSILUNINT)RTMemAllocZ((iLun + 1) * sizeof(PVSCSILUNINT));
210 if (pVScsiDevice->papVScsiLun)
211 {
212 for (uint32_t i = 0; i < pVScsiDevice->cLunsMax; i++)
213 pVScsiDevice->papVScsiLun[i] = papLunOld[i];
214
215 if (papLunOld)
216 RTMemFree(papLunOld);
217
218 pVScsiDevice->cLunsMax = iLun + 1;
219 }
220 else
221 rc = VERR_NO_MEMORY;
222 }
223
224 if (RT_SUCCESS(rc))
225 {
226 pVScsiLun->pVScsiDevice = pVScsiDevice;
227 pVScsiDevice->papVScsiLun[iLun] = pVScsiLun;
228 pVScsiDevice->cLunsAttached++;
229 }
230
231 return rc;
232}
233
234
235VBOXDDU_DECL(int) VSCSIDeviceLunDetach(VSCSIDEVICE hVScsiDevice, uint32_t iLun,
236 PVSCSILUN phVScsiLun)
237{
238 PVSCSIDEVICEINT pVScsiDevice = (PVSCSIDEVICEINT)hVScsiDevice;
239
240 /* Parameter checks */
241 AssertPtrReturn(pVScsiDevice, VERR_INVALID_HANDLE);
242 AssertPtrReturn(phVScsiLun, VERR_INVALID_POINTER);
243 AssertReturn(iLun < VSCSI_DEVICE_LUN_MAX, VERR_VSCSI_LUN_INVALID);
244 AssertReturn(iLun < pVScsiDevice->cLunsMax, VERR_VSCSI_LUN_NOT_ATTACHED);
245 AssertPtrReturn(pVScsiDevice->papVScsiLun[iLun], VERR_VSCSI_LUN_NOT_ATTACHED);
246
247 PVSCSILUNINT pVScsiLun = pVScsiDevice->papVScsiLun[iLun];
248
249 pVScsiLun->pVScsiDevice = NULL;
250 *phVScsiLun = pVScsiLun;
251 pVScsiDevice->papVScsiLun[iLun] = NULL;
252 pVScsiDevice->cLunsAttached--;
253
254 return VINF_SUCCESS;
255}
256
257
258VBOXDDU_DECL(int) VSCSIDeviceLunGet(VSCSIDEVICE hVScsiDevice, uint32_t iLun,
259 PVSCSILUN phVScsiLun)
260{
261 PVSCSIDEVICEINT pVScsiDevice = (PVSCSIDEVICEINT)hVScsiDevice;
262
263 /* Parameter checks */
264 AssertPtrReturn(pVScsiDevice, VERR_INVALID_HANDLE);
265 AssertPtrReturn(phVScsiLun, VERR_INVALID_POINTER);
266 AssertReturn(iLun < VSCSI_DEVICE_LUN_MAX, VERR_VSCSI_LUN_INVALID);
267 AssertReturn(iLun < pVScsiDevice->cLunsMax, VERR_VSCSI_LUN_NOT_ATTACHED);
268 AssertPtrReturn(pVScsiDevice->papVScsiLun[iLun], VERR_VSCSI_LUN_NOT_ATTACHED);
269
270 *phVScsiLun = pVScsiDevice->papVScsiLun[iLun];
271
272 return VINF_SUCCESS;
273}
274
275
276VBOXDDU_DECL(int) VSCSIDeviceReqEnqueue(VSCSIDEVICE hVScsiDevice, VSCSIREQ hVScsiReq)
277{
278 PVSCSIDEVICEINT pVScsiDevice = (PVSCSIDEVICEINT)hVScsiDevice;
279 PVSCSIREQINT pVScsiReq = (PVSCSIREQINT)hVScsiReq;
280 int rc = VINF_SUCCESS;
281
282 /* Parameter checks */
283 AssertPtrReturn(pVScsiDevice, VERR_INVALID_HANDLE);
284 AssertPtrReturn(pVScsiReq, VERR_INVALID_HANDLE);
285
286 /* Check if this request can be handled by us */
287 int rcReq;
288 bool fProcessed = vscsiDeviceReqProcess(pVScsiDevice, pVScsiReq, &rcReq);
289 if (!fProcessed)
290 {
291 /* Pass to the LUN driver */
292 if (vscsiDeviceLunIsPresent(pVScsiDevice, pVScsiReq->iLun))
293 {
294 PVSCSILUNINT pVScsiLun = pVScsiDevice->papVScsiLun[pVScsiReq->iLun];
295 rc = pVScsiLun->pVScsiLunDesc->pfnVScsiLunReqProcess(pVScsiLun, pVScsiReq);
296 }
297 else
298 {
299 /* LUN not present, report error. */
300 vscsiReqSenseErrorSet(&pVScsiDevice->VScsiSense, pVScsiReq,
301 SCSI_SENSE_ILLEGAL_REQUEST,
302 SCSI_ASC_LOGICAL_UNIT_DOES_NOT_RESPOND_TO_SELECTION,
303 0x00);
304
305 vscsiDeviceReqComplete(pVScsiDevice, pVScsiReq,
306 SCSI_STATUS_CHECK_CONDITION, false, VINF_SUCCESS);
307 }
308 }
309 else
310 vscsiDeviceReqComplete(pVScsiDevice, pVScsiReq,
311 rcReq, false, VINF_SUCCESS);
312
313 return rc;
314}
315
316
317VBOXDDU_DECL(int) VSCSIDeviceReqCreate(VSCSIDEVICE hVScsiDevice, PVSCSIREQ phVScsiReq,
318 uint32_t iLun, uint8_t *pbCDB, size_t cbCDB,
319 size_t cbSGList, unsigned cSGListEntries,
320 PCRTSGSEG paSGList, uint8_t *pbSense,
321 size_t cbSense, void *pvVScsiReqUser)
322{
323 PVSCSIDEVICEINT pVScsiDevice = (PVSCSIDEVICEINT)hVScsiDevice;
324 PVSCSIREQINT pVScsiReq = NULL;
325
326 /* Parameter checks */
327 AssertPtrReturn(pVScsiDevice, VERR_INVALID_HANDLE);
328 AssertPtrReturn(phVScsiReq, VERR_INVALID_POINTER);
329 AssertPtrReturn(pbCDB, VERR_INVALID_PARAMETER);
330 AssertReturn(cbCDB > 0, VERR_INVALID_PARAMETER);
331
332 pVScsiReq = (PVSCSIREQINT)RTMemCacheAlloc(pVScsiDevice->hCacheReq);
333 if (!pVScsiReq)
334 return VERR_NO_MEMORY;
335
336 pVScsiReq->iLun = iLun;
337 pVScsiReq->pbCDB = pbCDB;
338 pVScsiReq->cbCDB = cbCDB;
339 pVScsiReq->pbSense = pbSense;
340 pVScsiReq->cbSense = cbSense;
341 pVScsiReq->pvVScsiReqUser = pvVScsiReqUser;
342
343 if (cSGListEntries)
344 RTSgBufInit(&pVScsiReq->SgBuf, paSGList, cSGListEntries);
345
346 *phVScsiReq = pVScsiReq;
347
348 return VINF_SUCCESS;
349}
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette