1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
6 * This work is largely based on the "vhost-user-scsi" implementation by
7 * SPDK(https://github.com/spdk/spdk).
18 #include <rte_atomic.h>
19 #include <rte_cycles.h>
21 #include <rte_malloc.h>
22 #include <rte_byteorder.h>
24 #include "vhost_scsi.h"
25 #include "scsi_spec.h"
27 #define INQ_OFFSET(field) (offsetof(struct scsi_cdb_inquiry_data, field) + \
28 sizeof(((struct scsi_cdb_inquiry_data *)0x0)->field))
31 vhost_strcpy_pad(void *dst, const char *src, size_t size, int pad)
37 memcpy(dst, src, len);
38 memset((char *)dst + len, pad, size - len);
40 memcpy(dst, src, size);
45 vhost_hex2bin(char ch)
47 if ((ch >= '0') && (ch <= '9'))
50 if ((ch >= 'a') && (ch <= 'f'))
56 vhost_bdev_scsi_set_naa_ieee_extended(const char *name, uint8_t *buf)
58 int i, value, count = 0;
59 uint64_t *temp64, local_value;
61 for (i = 0; (i < 16) && (name[i] != '\0'); i++) {
62 value = vhost_hex2bin(name[i]);
64 buf[count++] |= value << 4;
69 local_value = *(uint64_t *)buf;
71 * see spc3r23 7.6.3.6.2,
72 * NAA IEEE Extended identifer format
74 local_value &= 0x0fff000000ffffffull;
75 /* NAA 02, and 00 03 47 for IEEE Intel */
76 local_value |= 0x2000000347000000ull;
78 temp64 = (uint64_t *)buf;
79 *temp64 = rte_cpu_to_be_64(local_value);
83 scsi_task_build_sense_data(struct vhost_scsi_task *task, int sk,
89 resp_code = 0x70; /* Current + Fixed format */
92 cp = (uint8_t *)task->resp->sense;
94 /* VALID(7) RESPONSE CODE(6-0) */
95 cp[0] = 0x80 | resp_code;
98 /* FILEMARK(7) EOM(6) ILI(5) SENSE KEY(3-0) */
101 memset(&cp[3], 0, 4);
103 /* ADDITIONAL SENSE LENGTH */
106 /* COMMAND-SPECIFIC INFORMATION */
107 memset(&cp[8], 0, 4);
108 /* ADDITIONAL SENSE CODE */
110 /* ADDITIONAL SENSE CODE QUALIFIER */
112 /* FIELD REPLACEABLE UNIT CODE */
115 /* SKSV(7) SENSE KEY SPECIFIC(6-0,7-0,7-0) */
121 task->resp->sense_len = 18;
125 scsi_task_set_status(struct vhost_scsi_task *task, int sc, int sk,
128 if (sc == SCSI_STATUS_CHECK_CONDITION)
129 scsi_task_build_sense_data(task, sk, asc, ascq);
130 task->resp->status = sc;
134 vhost_bdev_scsi_inquiry_command(struct vhost_block_dev *bdev,
135 struct vhost_scsi_task *task)
138 uint32_t alloc_len = 0;
146 struct scsi_cdb_inquiry *inq;
148 inq = (struct scsi_cdb_inquiry *)task->req->cdb;
150 assert(task->iovs_cnt == 1);
152 /* At least 36Bytes for inquiry command */
153 if (task->data_len < 0x24)
156 pd = SPC_PERIPHERAL_DEVICE_TYPE_DISK;
158 evpd = inq->evpd & 0x1;
164 struct scsi_vpd_page *vpage = (struct scsi_vpd_page *)
165 task->iovs[0].iov_base;
167 /* PERIPHERAL QUALIFIER(7-5) PERIPHERAL DEVICE TYPE(4-0) */
168 vpage->peripheral = pd;
170 vpage->page_code = pc;
173 case SPC_VPD_SUPPORTED_VPD_PAGES:
175 vpage->params[0] = SPC_VPD_SUPPORTED_VPD_PAGES;
176 vpage->params[1] = SPC_VPD_UNIT_SERIAL_NUMBER;
177 vpage->params[2] = SPC_VPD_DEVICE_IDENTIFICATION;
180 vpage->alloc_len = rte_cpu_to_be_16(len);
182 case SPC_VPD_UNIT_SERIAL_NUMBER:
184 strncpy((char *)vpage->params, bdev->name, 32);
185 vpage->alloc_len = rte_cpu_to_be_16(32);
187 case SPC_VPD_DEVICE_IDENTIFICATION:
189 struct scsi_desig_desc *desig;
193 desig = (struct scsi_desig_desc *)buf;
194 desig->code_set = SPC_VPD_CODE_SET_BINARY;
195 desig->protocol_id = SPC_PROTOCOL_IDENTIFIER_ISCSI;
196 desig->type = SPC_VPD_IDENTIFIER_TYPE_NAA;
197 desig->association = SPC_VPD_ASSOCIATION_LOGICAL_UNIT;
198 desig->reserved0 = 0;
200 desig->reserved1 = 0;
202 vhost_bdev_scsi_set_naa_ieee_extended(bdev->name,
204 len = sizeof(struct scsi_desig_desc) + 8;
206 buf += sizeof(struct scsi_desig_desc) + desig->len;
208 /* T10 Vendor ID designator */
209 desig = (struct scsi_desig_desc *)buf;
210 desig->code_set = SPC_VPD_CODE_SET_ASCII;
211 desig->protocol_id = SPC_PROTOCOL_IDENTIFIER_ISCSI;
212 desig->type = SPC_VPD_IDENTIFIER_TYPE_T10_VENDOR_ID;
213 desig->association = SPC_VPD_ASSOCIATION_LOGICAL_UNIT;
214 desig->reserved0 = 0;
216 desig->reserved1 = 0;
217 desig->len = 8 + 16 + 32;
218 strncpy((char *)desig->desig, "INTEL", 8);
219 vhost_strcpy_pad((char *)&desig->desig[8],
220 bdev->product_name, 16, ' ');
221 strncpy((char *)&desig->desig[24], bdev->name, 32);
222 len += sizeof(struct scsi_desig_desc) + 8 + 16 + 32;
224 buf += sizeof(struct scsi_desig_desc) + desig->len;
226 /* SCSI Device Name designator */
227 desig = (struct scsi_desig_desc *)buf;
228 desig->code_set = SPC_VPD_CODE_SET_UTF8;
229 desig->protocol_id = SPC_PROTOCOL_IDENTIFIER_ISCSI;
230 desig->type = SPC_VPD_IDENTIFIER_TYPE_SCSI_NAME;
231 desig->association = SPC_VPD_ASSOCIATION_TARGET_DEVICE;
232 desig->reserved0 = 0;
234 desig->reserved1 = 0;
235 desig->len = snprintf((char *)desig->desig,
236 255, "%s", bdev->name);
237 len += sizeof(struct scsi_desig_desc) + desig->len;
239 buf += sizeof(struct scsi_desig_desc) + desig->len;
240 vpage->alloc_len = rte_cpu_to_be_16(len);
247 struct scsi_cdb_inquiry_data *inqdata =
248 (struct scsi_cdb_inquiry_data *)task->iovs[0].iov_base;
249 /* Standard INQUIRY data */
250 /* PERIPHERAL QUALIFIER(7-5) PERIPHERAL DEVICE TYPE(4-0) */
251 inqdata->peripheral = pd;
257 /* See SPC3/SBC2/MMC4/SAM2 for more details */
258 inqdata->version = SPC_VERSION_SPC3;
260 /* NORMACA(5) HISUP(4) RESPONSE DATA FORMAT(3-0) */
261 /* format 2 */ /* hierarchical support */
262 inqdata->response = 2 | 1 << 4;
266 /* SCCS(7) ACC(6) TPGS(5-4) 3PC(3) PROTECT(0) */
267 /* Not support TPGS */
271 inqdata->flags2 = 0x10;
273 /* WBUS16(5) SYNC(4) LINKED(3) CMDQUE(1) VS(0) */
275 inqdata->flags3 = 0x2;
277 /* T10 VENDOR IDENTIFICATION */
278 strncpy((char *)inqdata->t10_vendor_id, "INTEL", 8);
280 /* PRODUCT IDENTIFICATION */
281 snprintf((char *)inqdata->product_id,
282 RTE_DIM(inqdata->product_id), "%s",
285 /* PRODUCT REVISION LEVEL */
286 strncpy((char *)inqdata->product_rev, "0001", 4);
288 /* Standard inquiry data ends here. Only populate
289 * remaining fields if alloc_len indicates enough
292 len = INQ_OFFSET(product_rev) - 5;
294 if (alloc_len >= INQ_OFFSET(vendor)) {
295 /* Vendor specific */
296 memset(inqdata->vendor, 0x20, 20);
297 len += sizeof(inqdata->vendor);
300 if (alloc_len >= INQ_OFFSET(ius)) {
301 /* CLOCKING(3-2) QAS(1) IUS(0) */
303 len += sizeof(inqdata->ius);
306 if (alloc_len >= INQ_OFFSET(reserved)) {
308 inqdata->reserved = 0;
309 len += sizeof(inqdata->reserved);
312 /* VERSION DESCRIPTOR 1-8 */
313 if (alloc_len >= INQ_OFFSET(reserved) + 2) {
314 temp16 = (uint16_t *)&inqdata->desc[0];
315 *temp16 = rte_cpu_to_be_16(0x0960);
319 if (alloc_len >= INQ_OFFSET(reserved) + 4) {
320 /* SPC-3 (no version claimed) */
321 temp16 = (uint16_t *)&inqdata->desc[2];
322 *temp16 = rte_cpu_to_be_16(0x0300);
326 if (alloc_len >= INQ_OFFSET(reserved) + 6) {
327 /* SBC-2 (no version claimed) */
328 temp16 = (uint16_t *)&inqdata->desc[4];
329 *temp16 = rte_cpu_to_be_16(0x0320);
333 if (alloc_len >= INQ_OFFSET(reserved) + 8) {
334 /* SAM-2 (no version claimed) */
335 temp16 = (uint16_t *)&inqdata->desc[6];
336 *temp16 = rte_cpu_to_be_16(0x0040);
340 if (alloc_len > INQ_OFFSET(reserved) + 8) {
341 i = alloc_len - (INQ_OFFSET(reserved) + 8);
344 memset(&inqdata->desc[8], 0, i);
348 /* ADDITIONAL LENGTH */
349 inqdata->add_len = len;
353 scsi_task_set_status(task, SCSI_STATUS_GOOD, 0, 0, 0);
357 scsi_task_set_status(task, SCSI_STATUS_CHECK_CONDITION,
358 SCSI_SENSE_ILLEGAL_REQUEST,
359 SCSI_ASC_INVALID_FIELD_IN_CDB,
360 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
365 vhost_bdev_scsi_readwrite(struct vhost_block_dev *bdev,
366 struct vhost_scsi_task *task,
367 uint64_t lba, __rte_unused uint32_t xfer_len)
373 offset = lba * bdev->blocklen;
375 for (i = 0; i < task->iovs_cnt; i++) {
376 if (task->dxfer_dir == SCSI_DIR_TO_DEV)
377 memcpy(bdev->data + offset, task->iovs[i].iov_base,
378 task->iovs[i].iov_len);
380 memcpy(task->iovs[i].iov_base, bdev->data + offset,
381 task->iovs[i].iov_len);
382 offset += task->iovs[i].iov_len;
383 nbytes += task->iovs[i].iov_len;
390 vhost_bdev_scsi_process_block(struct vhost_block_dev *bdev,
391 struct vhost_scsi_task *task)
393 uint64_t lba, *temp64;
394 uint32_t xfer_len, *temp32;
396 uint8_t *cdb = (uint8_t *)task->req->cdb;
401 lba = (uint64_t)cdb[1] << 16;
402 lba |= (uint64_t)cdb[2] << 8;
403 lba |= (uint64_t)cdb[3];
407 return vhost_bdev_scsi_readwrite(bdev, task, lba, xfer_len);
411 temp32 = (uint32_t *)&cdb[2];
412 lba = rte_be_to_cpu_32(*temp32);
413 temp16 = (uint16_t *)&cdb[7];
414 xfer_len = rte_be_to_cpu_16(*temp16);
415 return vhost_bdev_scsi_readwrite(bdev, task, lba, xfer_len);
419 temp32 = (uint32_t *)&cdb[2];
420 lba = rte_be_to_cpu_32(*temp32);
421 temp32 = (uint32_t *)&cdb[6];
422 xfer_len = rte_be_to_cpu_32(*temp32);
423 return vhost_bdev_scsi_readwrite(bdev, task, lba, xfer_len);
427 temp64 = (uint64_t *)&cdb[2];
428 lba = rte_be_to_cpu_64(*temp64);
429 temp32 = (uint32_t *)&cdb[10];
430 xfer_len = rte_be_to_cpu_32(*temp32);
431 return vhost_bdev_scsi_readwrite(bdev, task, lba, xfer_len);
433 case SBC_READ_CAPACITY_10: {
436 if (bdev->blockcnt - 1 > 0xffffffffULL)
437 memset(buffer, 0xff, 4);
439 temp32 = (uint32_t *)buffer;
440 *temp32 = rte_cpu_to_be_32(bdev->blockcnt - 1);
442 temp32 = (uint32_t *)&buffer[4];
443 *temp32 = rte_cpu_to_be_32(bdev->blocklen);
444 memcpy(task->iovs[0].iov_base, buffer, sizeof(buffer));
445 task->resp->status = SCSI_STATUS_GOOD;
446 return sizeof(buffer);
449 case SBC_SYNCHRONIZE_CACHE_10:
450 case SBC_SYNCHRONIZE_CACHE_16:
451 task->resp->status = SCSI_STATUS_GOOD;
455 scsi_task_set_status(task, SCSI_STATUS_CHECK_CONDITION,
456 SCSI_SENSE_ILLEGAL_REQUEST,
457 SCSI_ASC_INVALID_FIELD_IN_CDB,
458 SCSI_ASCQ_CAUSE_NOT_REPORTABLE);
463 vhost_bdev_process_scsi_commands(struct vhost_block_dev *bdev,
464 struct vhost_scsi_task *task)
468 uint64_t *temp64, fmt_lun = 0;
471 uint8_t *cdb = (uint8_t *)task->req->cdb;
473 lun = (const uint8_t *)task->req->lun;
474 /* only 1 LUN supported */
475 if (lun[0] != 1 || lun[1] >= 1)
480 len = vhost_bdev_scsi_inquiry_command(bdev, task);
481 task->data_len = len;
483 case SPC_REPORT_LUNS:
484 data = (uint8_t *)task->iovs[0].iov_base;
485 fmt_lun |= (0x0ULL & 0x00ffULL) << 48;
486 temp64 = (uint64_t *)&data[8];
487 *temp64 = rte_cpu_to_be_64(fmt_lun);
488 temp32 = (uint32_t *)data;
489 *temp32 = rte_cpu_to_be_32(8);
491 scsi_task_set_status(task, SCSI_STATUS_GOOD, 0, 0, 0);
493 case SPC_MODE_SELECT_6:
494 case SPC_MODE_SELECT_10:
495 /* don't support it now */
496 scsi_task_set_status(task, SCSI_STATUS_GOOD, 0, 0, 0);
498 case SPC_MODE_SENSE_6:
499 case SPC_MODE_SENSE_10:
500 /* don't support it now */
501 scsi_task_set_status(task, SCSI_STATUS_GOOD, 0, 0, 0);
503 case SPC_TEST_UNIT_READY:
504 scsi_task_set_status(task, SCSI_STATUS_GOOD, 0, 0, 0);
507 len = vhost_bdev_scsi_process_block(bdev, task);
508 task->data_len = len;