]> git.proxmox.com Git - mirror_qemu.git/blame - block/iscsi.c
i386: Update new x86_apicid parsing rules with die_offset support
[mirror_qemu.git] / block / iscsi.c
CommitLineData
c589b249
RS
1/*
2 * QEMU Block driver for iSCSI images
3 *
4 * Copyright (c) 2010-2011 Ronnie Sahlberg <ronniesahlberg@gmail.com>
aef172ff 5 * Copyright (c) 2012-2017 Peter Lieven <pl@kamp.de>
c589b249
RS
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
25
80c71a24 26#include "qemu/osdep.h"
c589b249
RS
27
28#include <poll.h>
efc6de0d 29#include <math.h>
f4dfa67f 30#include <arpa/inet.h>
a8d25326 31#include "qemu-common.h"
1de7afc9
PB
32#include "qemu/config-file.h"
33#include "qemu/error-report.h"
b03c3805
PL
34#include "qemu/bitops.h"
35#include "qemu/bitmap.h"
737e150e 36#include "block/block_int.h"
609f45ea 37#include "block/qdict.h"
08e2c9f1 38#include "scsi/constants.h"
0a53f010 39#include "qemu/iov.h"
0b8fa32f 40#include "qemu/module.h"
922a01a0 41#include "qemu/option.h"
cea25275 42#include "qemu/uuid.h"
e688df6b 43#include "qapi/error.h"
112ed241 44#include "qapi/qapi-commands-misc.h"
452fcdbc 45#include "qapi/qmp/qdict.h"
d49b6836 46#include "qapi/qmp/qstring.h"
b189346e 47#include "crypto/secret.h"
e5b5728c 48#include "scsi/utils.h"
ecc983a5 49#include "trace.h"
c589b249 50
e5b5728c
PB
51/* Conflict between scsi/utils.h and libiscsi! :( */
52#define SCSI_XFER_NONE ISCSI_XFER_NONE
c589b249 53#include <iscsi/iscsi.h>
df71ca84 54#define inline __attribute__((gnu_inline)) /* required for libiscsi v1.9.0 */
c589b249 55#include <iscsi/scsi-lowlevel.h>
df71ca84 56#undef inline
e5b5728c
PB
57#undef SCSI_XFER_NONE
58QEMU_BUILD_BUG_ON((int)SCSI_XFER_NONE != (int)ISCSI_XFER_NONE);
c589b249 59
98392453
RS
60#ifdef __linux__
61#include <scsi/sg.h>
98392453 62#endif
c589b249
RS
63
64typedef struct IscsiLun {
65 struct iscsi_context *iscsi;
80cf6257 66 AioContext *aio_context;
c589b249 67 int lun;
dbfff6d7 68 enum scsi_inquiry_peripheral_device_type type;
c589b249 69 int block_size;
c7b4a952 70 uint64_t num_blocks;
c9b9f682 71 int events;
5b5d34ec 72 QEMUTimer *nop_timer;
05b685fb 73 QEMUTimer *event_timer;
d045c466 74 QemuMutex mutex;
f18a7cbb
PL
75 struct scsi_inquiry_logical_block_provisioning lbp;
76 struct scsi_inquiry_block_limits bl;
cc9743c2 77 struct scsi_inquiry_device_designator *dd;
d4cd9615 78 unsigned char *zeroblock;
e1123a3b
PL
79 /* The allocmap tracks which clusters (pages) on the iSCSI target are
80 * allocated and which are not. In case a target returns zeros for
81 * unallocated pages (iscsilun->lprz) we can directly return zeros instead
82 * of reading zeros over the wire if a read request falls within an
83 * unallocated block. As there are 3 possible states we need 2 bitmaps to
84 * track. allocmap_valid keeps track if QEMU's information about a page is
85 * valid. allocmap tracks if a page is allocated or not. In case QEMU has no
86 * valid information about a page the corresponding allocmap entry should be
87 * switched to unallocated as well to force a new lookup of the allocation
88 * status as lookups are generally skipped if a page is suspect to be
89 * allocated. If a iSCSI target is opened with cache.direct = on the
90 * allocmap_valid does not exist turning all cached information invalid so
91 * that a fresh lookup is made for any page even if allocmap entry returns
92 * it's unallocated. */
93 unsigned long *allocmap;
94 unsigned long *allocmap_valid;
95 long allocmap_size;
ba059e7b 96 int cluster_size;
9281fe9e 97 bool use_16_for_rw;
43ae8fb1 98 bool write_protected;
0a386e48
PL
99 bool lbpme;
100 bool lbprz;
752ce451 101 bool dpofua;
0a386e48 102 bool has_write_same;
5dd7a535 103 bool request_timed_out;
c589b249
RS
104} IscsiLun;
105
54a5c1d5
PL
106typedef struct IscsiTask {
107 int status;
108 int complete;
109 int retries;
110 int do_retry;
111 struct scsi_task *task;
112 Coroutine *co;
80cf6257 113 IscsiLun *iscsilun;
efc6de0d 114 QEMUTimer retry_timer;
e01dd3da 115 int err_code;
e38bc234 116 char *err_str;
54a5c1d5
PL
117} IscsiTask;
118
c589b249 119typedef struct IscsiAIOCB {
7c84b1b8 120 BlockAIOCB common;
c589b249
RS
121 QEMUBH *bh;
122 IscsiLun *iscsilun;
123 struct scsi_task *task;
c589b249 124 int status;
1dde716e
PL
125 int64_t sector_num;
126 int nb_sectors;
4bb17ab5 127 int ret;
98392453
RS
128#ifdef __linux__
129 sg_io_hdr_t *ioh;
130#endif
c1004487 131 bool cancelled;
c589b249
RS
132} IscsiAIOCB;
133
5dd7a535
PL
134/* libiscsi uses time_t so its enough to process events every second */
135#define EVENT_INTERVAL 1000
5b5d34ec
PL
136#define NOP_INTERVAL 5000
137#define MAX_NOP_FAILURES 3
efc6de0d 138#define ISCSI_CMD_RETRIES ARRAY_SIZE(iscsi_retry_times)
59dd0a22 139static const unsigned iscsi_retry_times[] = {8, 32, 128, 512, 2048, 8192, 32768};
5b5d34ec 140
5d831be2 141/* this threshold is a trade-off knob to choose between
5917af81
PL
142 * the potential additional overhead of an extra GET_LBA_STATUS request
143 * vs. unnecessarily reading a lot of zero sectors over the wire.
144 * If a read request is greater or equal than ISCSI_CHECKALLOC_THRES
145 * sectors we check the allocation status of the area covered by the
146 * request first if the allocationmap indicates that the area might be
147 * unallocated. */
148#define ISCSI_CHECKALLOC_THRES 64
5b5d34ec 149
d4cef0c6
PMD
150#ifdef __linux__
151
27cbd828 152static void
cfb3f506 153iscsi_bh_cb(void *p)
27cbd828
PB
154{
155 IscsiAIOCB *acb = p;
156
157 qemu_bh_delete(acb->bh);
158
722d9333 159 acb->common.cb(acb->common.opaque, acb->status);
27cbd828 160
1bd075f2
PB
161 if (acb->task != NULL) {
162 scsi_free_scsi_task(acb->task);
163 acb->task = NULL;
164 }
165
8007429a 166 qemu_aio_unref(acb);
27cbd828
PB
167}
168
cfb3f506
PB
169static void
170iscsi_schedule_bh(IscsiAIOCB *acb)
27cbd828 171{
1bd075f2
PB
172 if (acb->bh) {
173 return;
174 }
80cf6257 175 acb->bh = aio_bh_new(acb->iscsilun->aio_context, iscsi_bh_cb, acb);
27cbd828 176 qemu_bh_schedule(acb->bh);
27cbd828
PB
177}
178
d4cef0c6
PMD
179#endif
180
8b9dfe90
PL
181static void iscsi_co_generic_bh_cb(void *opaque)
182{
183 struct IscsiTask *iTask = opaque;
1919631e 184
fcd470d8 185 iTask->complete = 1;
1919631e 186 aio_co_wake(iTask->co);
8b9dfe90
PL
187}
188
efc6de0d
PL
189static void iscsi_retry_timer_expired(void *opaque)
190{
191 struct IscsiTask *iTask = opaque;
fcd470d8 192 iTask->complete = 1;
efc6de0d 193 if (iTask->co) {
2f47da5f 194 aio_co_wake(iTask->co);
efc6de0d
PL
195 }
196}
197
198static inline unsigned exp_random(double mean)
199{
200 return -mean * log((double)rand() / RAND_MAX);
201}
202
e01dd3da
FZ
203/* SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST was introduced in
204 * libiscsi 1.10.0, together with other constants we need. Use it as
205 * a hint that we have to define them ourselves if needed, to keep the
206 * minimum required libiscsi version at 1.9.0. We use an ASCQ macro for
207 * the test because SCSI_STATUS_* is an enum.
208 *
209 * To guard against future changes where SCSI_SENSE_ASCQ_* also becomes
210 * an enum, check against the LIBISCSI_API_VERSION macro, which was
211 * introduced in 1.11.0. If it is present, there is no need to define
212 * anything.
213 */
214#if !defined(SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST) && \
215 !defined(LIBISCSI_API_VERSION)
216#define SCSI_STATUS_TASK_SET_FULL 0x28
217#define SCSI_STATUS_TIMEOUT 0x0f000002
218#define SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST 0x2600
219#define SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR 0x1a00
9049736e
PL
220#endif
221
583ec22e
RS
222#ifndef LIBISCSI_API_VERSION
223#define LIBISCSI_API_VERSION 20130701
224#endif
225
e01dd3da
FZ
226static int iscsi_translate_sense(struct scsi_sense *sense)
227{
28751358
FZ
228 return - scsi_sense_to_errno(sense->key,
229 (sense->ascq & 0xFF00) >> 8,
230 sense->ascq & 0xFF);
e01dd3da
FZ
231}
232
d045c466 233/* Called (via iscsi_service) with QemuMutex held. */
54a5c1d5
PL
234static void
235iscsi_co_generic_cb(struct iscsi_context *iscsi, int status,
236 void *command_data, void *opaque)
237{
238 struct IscsiTask *iTask = opaque;
239 struct scsi_task *task = command_data;
240
54a5c1d5
PL
241 iTask->status = status;
242 iTask->do_retry = 0;
243 iTask->task = task;
244
54a5c1d5 245 if (status != SCSI_STATUS_GOOD) {
efc6de0d
PL
246 if (iTask->retries++ < ISCSI_CMD_RETRIES) {
247 if (status == SCSI_STATUS_CHECK_CONDITION
248 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
249 error_report("iSCSI CheckCondition: %s",
250 iscsi_get_error(iscsi));
251 iTask->do_retry = 1;
252 goto out;
253 }
9049736e 254 if (status == SCSI_STATUS_BUSY ||
e01dd3da
FZ
255 status == SCSI_STATUS_TIMEOUT ||
256 status == SCSI_STATUS_TASK_SET_FULL) {
efc6de0d
PL
257 unsigned retry_time =
258 exp_random(iscsi_retry_times[iTask->retries - 1]);
e01dd3da 259 if (status == SCSI_STATUS_TIMEOUT) {
5dd7a535
PL
260 /* make sure the request is rescheduled AFTER the
261 * reconnect is initiated */
262 retry_time = EVENT_INTERVAL * 2;
263 iTask->iscsilun->request_timed_out = true;
264 }
265 error_report("iSCSI Busy/TaskSetFull/TimeOut"
266 " (retry #%u in %u ms): %s",
efc6de0d
PL
267 iTask->retries, retry_time,
268 iscsi_get_error(iscsi));
269 aio_timer_init(iTask->iscsilun->aio_context,
270 &iTask->retry_timer, QEMU_CLOCK_REALTIME,
271 SCALE_MS, iscsi_retry_timer_expired, iTask);
272 timer_mod(&iTask->retry_timer,
273 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + retry_time);
274 iTask->do_retry = 1;
275 return;
276 }
277 }
e01dd3da 278 iTask->err_code = iscsi_translate_sense(&task->sense);
e38bc234 279 iTask->err_str = g_strdup(iscsi_get_error(iscsi));
54a5c1d5
PL
280 }
281
282out:
283 if (iTask->co) {
fffb6e12
PB
284 aio_bh_schedule_oneshot(iTask->iscsilun->aio_context,
285 iscsi_co_generic_bh_cb, iTask);
fcd470d8
PL
286 } else {
287 iTask->complete = 1;
54a5c1d5
PL
288 }
289}
290
291static void iscsi_co_init_iscsitask(IscsiLun *iscsilun, struct IscsiTask *iTask)
292{
293 *iTask = (struct IscsiTask) {
efc6de0d 294 .co = qemu_coroutine_self(),
efc6de0d 295 .iscsilun = iscsilun,
54a5c1d5
PL
296 };
297}
27cbd828 298
d4cef0c6
PMD
299#ifdef __linux__
300
c1004487 301/* Called (via iscsi_service) with QemuMutex held. */
c589b249
RS
302static void
303iscsi_abort_task_cb(struct iscsi_context *iscsi, int status, void *command_data,
304 void *private_data)
305{
1bd075f2
PB
306 IscsiAIOCB *acb = private_data;
307
88e94fd2
SH
308 /* If the command callback hasn't been called yet, drop the task */
309 if (!acb->bh) {
310 /* Call iscsi_aio_ioctl_cb() with SCSI_STATUS_CANCELLED */
311 iscsi_scsi_cancel_task(iscsi, acb->task);
312 }
313
c1004487 314 qemu_aio_unref(acb); /* acquired in iscsi_aio_cancel() */
c589b249
RS
315}
316
317static void
7c84b1b8 318iscsi_aio_cancel(BlockAIOCB *blockacb)
c589b249
RS
319{
320 IscsiAIOCB *acb = (IscsiAIOCB *)blockacb;
321 IscsiLun *iscsilun = acb->iscsilun;
322
c1004487
SH
323 qemu_mutex_lock(&iscsilun->mutex);
324
325 /* If it was cancelled or completed already, our work is done here */
326 if (acb->cancelled || acb->status != -EINPROGRESS) {
327 qemu_mutex_unlock(&iscsilun->mutex);
1bd075f2
PB
328 return;
329 }
330
c1004487
SH
331 acb->cancelled = true;
332
333 qemu_aio_ref(acb); /* released in iscsi_abort_task_cb() */
334
b2090919 335 /* send a task mgmt call to the target to cancel the task on the target */
c1004487
SH
336 if (iscsi_task_mgmt_abort_task_async(iscsilun->iscsi, acb->task,
337 iscsi_abort_task_cb, acb) < 0) {
338 qemu_aio_unref(acb); /* since iscsi_abort_task_cb() won't be called */
339 }
b2090919 340
c1004487 341 qemu_mutex_unlock(&iscsilun->mutex);
c589b249
RS
342}
343
d7331bed 344static const AIOCBInfo iscsi_aiocb_info = {
c589b249 345 .aiocb_size = sizeof(IscsiAIOCB),
722d9333 346 .cancel_async = iscsi_aio_cancel,
c589b249
RS
347};
348
d4cef0c6 349#endif
c589b249
RS
350
351static void iscsi_process_read(void *arg);
352static void iscsi_process_write(void *arg);
353
d045c466 354/* Called with QemuMutex held. */
c589b249
RS
355static void
356iscsi_set_events(IscsiLun *iscsilun)
357{
358 struct iscsi_context *iscsi = iscsilun->iscsi;
05b685fb 359 int ev = iscsi_which_events(iscsi);
c9b9f682 360
c9b9f682 361 if (ev != iscsilun->events) {
dca21ef2
FZ
362 aio_set_fd_handler(iscsilun->aio_context, iscsi_get_fd(iscsi),
363 false,
05b685fb 364 (ev & POLLIN) ? iscsi_process_read : NULL,
80cf6257 365 (ev & POLLOUT) ? iscsi_process_write : NULL,
f6a51c84 366 NULL,
80cf6257 367 iscsilun);
05b685fb
PL
368 iscsilun->events = ev;
369 }
05b685fb 370}
c9b9f682 371
5dd7a535 372static void iscsi_timed_check_events(void *opaque)
05b685fb
PL
373{
374 IscsiLun *iscsilun = opaque;
5dd7a535 375
83d11973
SH
376 qemu_mutex_lock(&iscsilun->mutex);
377
5dd7a535
PL
378 /* check for timed out requests */
379 iscsi_service(iscsilun->iscsi, 0);
380
381 if (iscsilun->request_timed_out) {
382 iscsilun->request_timed_out = false;
383 iscsi_reconnect(iscsilun->iscsi);
384 }
385
386 /* newer versions of libiscsi may return zero events. Ensure we are able
387 * to return to service once this situation changes. */
05b685fb 388 iscsi_set_events(iscsilun);
5dd7a535 389
83d11973
SH
390 qemu_mutex_unlock(&iscsilun->mutex);
391
5dd7a535
PL
392 timer_mod(iscsilun->event_timer,
393 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + EVENT_INTERVAL);
c589b249
RS
394}
395
396static void
397iscsi_process_read(void *arg)
398{
399 IscsiLun *iscsilun = arg;
400 struct iscsi_context *iscsi = iscsilun->iscsi;
401
d045c466 402 qemu_mutex_lock(&iscsilun->mutex);
c589b249
RS
403 iscsi_service(iscsi, POLLIN);
404 iscsi_set_events(iscsilun);
d045c466 405 qemu_mutex_unlock(&iscsilun->mutex);
c589b249
RS
406}
407
408static void
409iscsi_process_write(void *arg)
410{
411 IscsiLun *iscsilun = arg;
412 struct iscsi_context *iscsi = iscsilun->iscsi;
413
d045c466 414 qemu_mutex_lock(&iscsilun->mutex);
c589b249
RS
415 iscsi_service(iscsi, POLLOUT);
416 iscsi_set_events(iscsilun);
d045c466 417 qemu_mutex_unlock(&iscsilun->mutex);
c589b249
RS
418}
419
0777b5dd
PL
420static int64_t sector_lun2qemu(int64_t sector, IscsiLun *iscsilun)
421{
422 return sector * iscsilun->block_size / BDRV_SECTOR_SIZE;
423}
424
c589b249
RS
425static int64_t sector_qemu2lun(int64_t sector, IscsiLun *iscsilun)
426{
427 return sector * BDRV_SECTOR_SIZE / iscsilun->block_size;
428}
429
94d047a3
EB
430static bool is_byte_request_lun_aligned(int64_t offset, int count,
431 IscsiLun *iscsilun)
91bea4e2 432{
94d047a3
EB
433 if (offset % iscsilun->block_size || count % iscsilun->block_size) {
434 error_report("iSCSI misaligned request: "
435 "iscsilun->block_size %u, offset %" PRIi64
436 ", count %d",
437 iscsilun->block_size, offset, count);
438 return false;
439 }
440 return true;
441}
442
443static bool is_sector_request_lun_aligned(int64_t sector_num, int nb_sectors,
444 IscsiLun *iscsilun)
445{
0ead9312 446 assert(nb_sectors <= BDRV_REQUEST_MAX_SECTORS);
94d047a3
EB
447 return is_byte_request_lun_aligned(sector_num << BDRV_SECTOR_BITS,
448 nb_sectors << BDRV_SECTOR_BITS,
449 iscsilun);
91bea4e2
PL
450}
451
e1123a3b 452static void iscsi_allocmap_free(IscsiLun *iscsilun)
a9fe4c95 453{
e1123a3b
PL
454 g_free(iscsilun->allocmap);
455 g_free(iscsilun->allocmap_valid);
456 iscsilun->allocmap = NULL;
457 iscsilun->allocmap_valid = NULL;
a9fe4c95
PL
458}
459
e1123a3b
PL
460
461static int iscsi_allocmap_init(IscsiLun *iscsilun, int open_flags)
b03c3805 462{
e1123a3b
PL
463 iscsi_allocmap_free(iscsilun);
464
ba059e7b 465 assert(iscsilun->cluster_size);
e1123a3b 466 iscsilun->allocmap_size =
ba059e7b
EB
467 DIV_ROUND_UP(iscsilun->num_blocks * iscsilun->block_size,
468 iscsilun->cluster_size);
e1123a3b
PL
469
470 iscsilun->allocmap = bitmap_try_new(iscsilun->allocmap_size);
471 if (!iscsilun->allocmap) {
472 return -ENOMEM;
b03c3805 473 }
e1123a3b
PL
474
475 if (open_flags & BDRV_O_NOCACHE) {
ba059e7b 476 /* when cache.direct = on all allocmap entries are
e1123a3b
PL
477 * treated as invalid to force a relookup of the block
478 * status on every read request */
479 return 0;
480 }
481
482 iscsilun->allocmap_valid = bitmap_try_new(iscsilun->allocmap_size);
483 if (!iscsilun->allocmap_valid) {
484 /* if we are under memory pressure free the allocmap as well */
485 iscsi_allocmap_free(iscsilun);
486 return -ENOMEM;
487 }
488
489 return 0;
b03c3805
PL
490}
491
e1123a3b 492static void
04a408fb
EB
493iscsi_allocmap_update(IscsiLun *iscsilun, int64_t offset,
494 int64_t bytes, bool allocated, bool valid)
b03c3805 495{
e1123a3b
PL
496 int64_t cl_num_expanded, nb_cls_expanded, cl_num_shrunk, nb_cls_shrunk;
497
498 if (iscsilun->allocmap == NULL) {
b03c3805
PL
499 return;
500 }
e1123a3b 501 /* expand to entirely contain all affected clusters */
04a408fb
EB
502 assert(iscsilun->cluster_size);
503 cl_num_expanded = offset / iscsilun->cluster_size;
504 nb_cls_expanded = DIV_ROUND_UP(offset + bytes,
505 iscsilun->cluster_size) - cl_num_expanded;
e1123a3b 506 /* shrink to touch only completely contained clusters */
04a408fb
EB
507 cl_num_shrunk = DIV_ROUND_UP(offset, iscsilun->cluster_size);
508 nb_cls_shrunk = (offset + bytes) / iscsilun->cluster_size - cl_num_shrunk;
e1123a3b
PL
509 if (allocated) {
510 bitmap_set(iscsilun->allocmap, cl_num_expanded, nb_cls_expanded);
511 } else {
1da45e0c
PL
512 if (nb_cls_shrunk > 0) {
513 bitmap_clear(iscsilun->allocmap, cl_num_shrunk, nb_cls_shrunk);
514 }
e1123a3b
PL
515 }
516
517 if (iscsilun->allocmap_valid == NULL) {
518 return;
519 }
520 if (valid) {
1da45e0c
PL
521 if (nb_cls_shrunk > 0) {
522 bitmap_set(iscsilun->allocmap_valid, cl_num_shrunk, nb_cls_shrunk);
523 }
e1123a3b
PL
524 } else {
525 bitmap_clear(iscsilun->allocmap_valid, cl_num_expanded,
526 nb_cls_expanded);
527 }
528}
529
530static void
04a408fb
EB
531iscsi_allocmap_set_allocated(IscsiLun *iscsilun, int64_t offset,
532 int64_t bytes)
e1123a3b 533{
04a408fb 534 iscsi_allocmap_update(iscsilun, offset, bytes, true, true);
e1123a3b
PL
535}
536
537static void
04a408fb
EB
538iscsi_allocmap_set_unallocated(IscsiLun *iscsilun, int64_t offset,
539 int64_t bytes)
e1123a3b
PL
540{
541 /* Note: if cache.direct=on the fifth argument to iscsi_allocmap_update
542 * is ignored, so this will in effect be an iscsi_allocmap_set_invalid.
543 */
04a408fb 544 iscsi_allocmap_update(iscsilun, offset, bytes, false, true);
e1123a3b
PL
545}
546
04a408fb
EB
547static void iscsi_allocmap_set_invalid(IscsiLun *iscsilun, int64_t offset,
548 int64_t bytes)
e1123a3b 549{
04a408fb 550 iscsi_allocmap_update(iscsilun, offset, bytes, false, false);
e1123a3b
PL
551}
552
553static void iscsi_allocmap_invalidate(IscsiLun *iscsilun)
554{
555 if (iscsilun->allocmap) {
556 bitmap_zero(iscsilun->allocmap, iscsilun->allocmap_size);
557 }
558 if (iscsilun->allocmap_valid) {
559 bitmap_zero(iscsilun->allocmap_valid, iscsilun->allocmap_size);
560 }
561}
562
563static inline bool
04a408fb
EB
564iscsi_allocmap_is_allocated(IscsiLun *iscsilun, int64_t offset,
565 int64_t bytes)
e1123a3b
PL
566{
567 unsigned long size;
568 if (iscsilun->allocmap == NULL) {
569 return true;
b03c3805 570 }
ba059e7b 571 assert(iscsilun->cluster_size);
04a408fb 572 size = DIV_ROUND_UP(offset + bytes, iscsilun->cluster_size);
e1123a3b 573 return !(find_next_bit(iscsilun->allocmap, size,
04a408fb 574 offset / iscsilun->cluster_size) == size);
e1123a3b
PL
575}
576
577static inline bool iscsi_allocmap_is_valid(IscsiLun *iscsilun,
04a408fb 578 int64_t offset, int64_t bytes)
e1123a3b
PL
579{
580 unsigned long size;
581 if (iscsilun->allocmap_valid == NULL) {
582 return false;
583 }
ba059e7b 584 assert(iscsilun->cluster_size);
04a408fb 585 size = DIV_ROUND_UP(offset + bytes, iscsilun->cluster_size);
e1123a3b 586 return (find_next_zero_bit(iscsilun->allocmap_valid, size,
04a408fb 587 offset / iscsilun->cluster_size) == size);
b03c3805
PL
588}
589
66e75c03
FZ
590static void coroutine_fn iscsi_co_wait_for_task(IscsiTask *iTask,
591 IscsiLun *iscsilun)
592{
593 while (!iTask->complete) {
594 iscsi_set_events(iscsilun);
595 qemu_mutex_unlock(&iscsilun->mutex);
596 qemu_coroutine_yield();
597 qemu_mutex_lock(&iscsilun->mutex);
598 }
599}
600
9f0eb9e1 601static int coroutine_fn
e18a58b4
EB
602iscsi_co_writev(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
603 QEMUIOVector *iov, int flags)
c589b249 604{
063c3378
PL
605 IscsiLun *iscsilun = bs->opaque;
606 struct IscsiTask iTask;
f4dfa67f 607 uint64_t lba;
063c3378 608 uint32_t num_sectors;
4df863f3 609 bool fua = flags & BDRV_REQ_FUA;
d045c466 610 int r = 0;
c589b249 611
4df863f3
EB
612 if (fua) {
613 assert(iscsilun->dpofua);
614 }
94d047a3 615 if (!is_sector_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
063c3378
PL
616 return -EINVAL;
617 }
7371d56f 618
6bd01f14
EB
619 if (bs->bl.max_transfer) {
620 assert(nb_sectors << BDRV_SECTOR_BITS <= bs->bl.max_transfer);
dc9e7163
PL
621 }
622
063c3378
PL
623 lba = sector_qemu2lun(sector_num, iscsilun);
624 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
063c3378 625 iscsi_co_init_iscsitask(iscsilun, &iTask);
d045c466 626 qemu_mutex_lock(&iscsilun->mutex);
063c3378 627retry:
9281fe9e 628 if (iscsilun->use_16_for_rw) {
583ec22e
RS
629#if LIBISCSI_API_VERSION >= (20160603)
630 iTask.task = iscsi_write16_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
631 NULL, num_sectors * iscsilun->block_size,
632 iscsilun->block_size, 0, 0, fua, 0, 0,
633 iscsi_co_generic_cb, &iTask,
634 (struct scsi_iovec *)iov->iov, iov->niov);
635 } else {
636 iTask.task = iscsi_write10_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
637 NULL, num_sectors * iscsilun->block_size,
638 iscsilun->block_size, 0, 0, fua, 0, 0,
639 iscsi_co_generic_cb, &iTask,
640 (struct scsi_iovec *)iov->iov, iov->niov);
641 }
642#else
9281fe9e 643 iTask.task = iscsi_write16_task(iscsilun->iscsi, iscsilun->lun, lba,
8c215a9f 644 NULL, num_sectors * iscsilun->block_size,
73b5394e 645 iscsilun->block_size, 0, 0, fua, 0, 0,
9281fe9e
PL
646 iscsi_co_generic_cb, &iTask);
647 } else {
648 iTask.task = iscsi_write10_task(iscsilun->iscsi, iscsilun->lun, lba,
8c215a9f 649 NULL, num_sectors * iscsilun->block_size,
73b5394e 650 iscsilun->block_size, 0, 0, fua, 0, 0,
9281fe9e
PL
651 iscsi_co_generic_cb, &iTask);
652 }
583ec22e 653#endif
063c3378 654 if (iTask.task == NULL) {
f6eb0b31 655 qemu_mutex_unlock(&iscsilun->mutex);
92397116 656 return -ENOMEM;
f4dfa67f 657 }
583ec22e 658#if LIBISCSI_API_VERSION < (20160603)
063c3378
PL
659 scsi_task_set_iov_out(iTask.task, (struct scsi_iovec *) iov->iov,
660 iov->niov);
583ec22e 661#endif
66e75c03 662 iscsi_co_wait_for_task(&iTask, iscsilun);
c589b249 663
063c3378
PL
664 if (iTask.task != NULL) {
665 scsi_free_scsi_task(iTask.task);
666 iTask.task = NULL;
91bea4e2
PL
667 }
668
063c3378 669 if (iTask.do_retry) {
837c3901 670 iTask.complete = 0;
063c3378 671 goto retry;
1dde716e
PL
672 }
673
063c3378 674 if (iTask.status != SCSI_STATUS_GOOD) {
04a408fb
EB
675 iscsi_allocmap_set_invalid(iscsilun, sector_num * BDRV_SECTOR_SIZE,
676 nb_sectors * BDRV_SECTOR_SIZE);
e38bc234
PL
677 error_report("iSCSI WRITE10/16 failed at lba %" PRIu64 ": %s", lba,
678 iTask.err_str);
d045c466
PB
679 r = iTask.err_code;
680 goto out_unlock;
c589b249
RS
681 }
682
04a408fb
EB
683 iscsi_allocmap_set_allocated(iscsilun, sector_num * BDRV_SECTOR_SIZE,
684 nb_sectors * BDRV_SECTOR_SIZE);
b03c3805 685
d045c466
PB
686out_unlock:
687 qemu_mutex_unlock(&iscsilun->mutex);
e38bc234 688 g_free(iTask.err_str);
d045c466 689 return r;
c589b249
RS
690}
691
b03c3805 692
b03c3805 693
92809c36
EB
694static int coroutine_fn iscsi_co_block_status(BlockDriverState *bs,
695 bool want_zero, int64_t offset,
696 int64_t bytes, int64_t *pnum,
697 int64_t *map,
698 BlockDriverState **file)
b03c3805
PL
699{
700 IscsiLun *iscsilun = bs->opaque;
701 struct scsi_get_lba_status *lbas = NULL;
702 struct scsi_lba_status_descriptor *lbasd = NULL;
703 struct IscsiTask iTask;
e38bc234 704 uint64_t lba;
92809c36 705 int ret;
b03c3805 706
79f9c75e
PL
707 iscsi_co_init_iscsitask(iscsilun, &iTask);
708
92809c36 709 assert(QEMU_IS_ALIGNED(offset | bytes, iscsilun->block_size));
b03c3805
PL
710
711 /* default to all sectors allocated */
92809c36
EB
712 ret = BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
713 if (map) {
714 *map = offset;
715 }
716 *pnum = bytes;
b03c3805
PL
717
718 /* LUN does not support logical block provisioning */
0a386e48 719 if (!iscsilun->lbpme) {
b03c3805
PL
720 goto out;
721 }
722
92809c36 723 lba = offset / iscsilun->block_size;
e38bc234 724
d045c466 725 qemu_mutex_lock(&iscsilun->mutex);
b03c3805
PL
726retry:
727 if (iscsi_get_lba_status_task(iscsilun->iscsi, iscsilun->lun,
e38bc234 728 lba, 8 + 16, iscsi_co_generic_cb,
b03c3805
PL
729 &iTask) == NULL) {
730 ret = -ENOMEM;
d045c466 731 goto out_unlock;
b03c3805 732 }
66e75c03 733 iscsi_co_wait_for_task(&iTask, iscsilun);
b03c3805
PL
734
735 if (iTask.do_retry) {
736 if (iTask.task != NULL) {
737 scsi_free_scsi_task(iTask.task);
738 iTask.task = NULL;
739 }
740 iTask.complete = 0;
741 goto retry;
742 }
743
744 if (iTask.status != SCSI_STATUS_GOOD) {
745 /* in case the get_lba_status_callout fails (i.e.
746 * because the device is busy or the cmd is not
747 * supported) we pretend all blocks are allocated
748 * for backwards compatibility */
e38bc234
PL
749 error_report("iSCSI GET_LBA_STATUS failed at lba %" PRIu64 ": %s",
750 lba, iTask.err_str);
d045c466 751 goto out_unlock;
b03c3805
PL
752 }
753
754 lbas = scsi_datain_unmarshall(iTask.task);
755 if (lbas == NULL) {
756 ret = -EIO;
d045c466 757 goto out_unlock;
b03c3805
PL
758 }
759
760 lbasd = &lbas->descriptors[0];
761
92809c36 762 if (lba != lbasd->lba) {
b03c3805 763 ret = -EIO;
d045c466 764 goto out_unlock;
b03c3805
PL
765 }
766
8ee1cef4 767 *pnum = (int64_t) lbasd->num_blocks * iscsilun->block_size;
b03c3805
PL
768
769 if (lbasd->provisioning == SCSI_PROVISIONING_TYPE_DEALLOCATED ||
770 lbasd->provisioning == SCSI_PROVISIONING_TYPE_ANCHORED) {
771 ret &= ~BDRV_BLOCK_DATA;
772 if (iscsilun->lbprz) {
773 ret |= BDRV_BLOCK_ZERO;
774 }
775 }
776
777 if (ret & BDRV_BLOCK_ZERO) {
92809c36 778 iscsi_allocmap_set_unallocated(iscsilun, offset, *pnum);
b03c3805 779 } else {
92809c36 780 iscsi_allocmap_set_allocated(iscsilun, offset, *pnum);
b03c3805
PL
781 }
782
92809c36
EB
783 if (*pnum > bytes) {
784 *pnum = bytes;
b03c3805 785 }
d045c466
PB
786out_unlock:
787 qemu_mutex_unlock(&iscsilun->mutex);
e38bc234 788 g_free(iTask.err_str);
b03c3805
PL
789out:
790 if (iTask.task != NULL) {
791 scsi_free_scsi_task(iTask.task);
792 }
92809c36 793 if (ret > 0 && ret & BDRV_BLOCK_OFFSET_VALID && file) {
3399833f
FZ
794 *file = bs;
795 }
b03c3805
PL
796 return ret;
797}
798
063c3378
PL
799static int coroutine_fn iscsi_co_readv(BlockDriverState *bs,
800 int64_t sector_num, int nb_sectors,
801 QEMUIOVector *iov)
c589b249 802{
063c3378
PL
803 IscsiLun *iscsilun = bs->opaque;
804 struct IscsiTask iTask;
1dde716e
PL
805 uint64_t lba;
806 uint32_t num_sectors;
e38bc234 807 int r = 0;
c589b249 808
94d047a3 809 if (!is_sector_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
063c3378 810 return -EINVAL;
f4dfa67f 811 }
f4dfa67f 812
6bd01f14
EB
813 if (bs->bl.max_transfer) {
814 assert(nb_sectors << BDRV_SECTOR_BITS <= bs->bl.max_transfer);
dc9e7163
PL
815 }
816
e1123a3b
PL
817 /* if cache.direct is off and we have a valid entry in our allocation map
818 * we can skip checking the block status and directly return zeroes if
819 * the request falls within an unallocated area */
04a408fb
EB
820 if (iscsi_allocmap_is_valid(iscsilun, sector_num * BDRV_SECTOR_SIZE,
821 nb_sectors * BDRV_SECTOR_SIZE) &&
822 !iscsi_allocmap_is_allocated(iscsilun, sector_num * BDRV_SECTOR_SIZE,
823 nb_sectors * BDRV_SECTOR_SIZE)) {
e1123a3b
PL
824 qemu_iovec_memset(iov, 0, 0x00, iov->size);
825 return 0;
826 }
827
828 if (nb_sectors >= ISCSI_CHECKALLOC_THRES &&
04a408fb
EB
829 !iscsi_allocmap_is_valid(iscsilun, sector_num * BDRV_SECTOR_SIZE,
830 nb_sectors * BDRV_SECTOR_SIZE) &&
831 !iscsi_allocmap_is_allocated(iscsilun, sector_num * BDRV_SECTOR_SIZE,
832 nb_sectors * BDRV_SECTOR_SIZE)) {
92809c36 833 int64_t pnum;
e1123a3b
PL
834 /* check the block status from the beginning of the cluster
835 * containing the start sector */
92809c36
EB
836 int64_t head;
837 int ret;
838
839 assert(iscsilun->cluster_size);
840 head = (sector_num * BDRV_SECTOR_SIZE) % iscsilun->cluster_size;
841 ret = iscsi_co_block_status(bs, true,
842 sector_num * BDRV_SECTOR_SIZE - head,
843 BDRV_REQUEST_MAX_BYTES, &pnum, NULL, NULL);
b03c3805
PL
844 if (ret < 0) {
845 return ret;
846 }
e1123a3b 847 /* if the whole request falls into an unallocated area we can avoid
ba059e7b 848 * reading and directly return zeroes instead */
e1123a3b 849 if (ret & BDRV_BLOCK_ZERO &&
92809c36 850 pnum >= nb_sectors * BDRV_SECTOR_SIZE + head) {
b03c3805
PL
851 qemu_iovec_memset(iov, 0, 0x00, iov->size);
852 return 0;
853 }
854 }
b03c3805 855
063c3378
PL
856 lba = sector_qemu2lun(sector_num, iscsilun);
857 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
f4dfa67f 858
063c3378 859 iscsi_co_init_iscsitask(iscsilun, &iTask);
d045c466 860 qemu_mutex_lock(&iscsilun->mutex);
063c3378 861retry:
9281fe9e 862 if (iscsilun->use_16_for_rw) {
583ec22e
RS
863#if LIBISCSI_API_VERSION >= (20160603)
864 iTask.task = iscsi_read16_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
865 num_sectors * iscsilun->block_size,
866 iscsilun->block_size, 0, 0, 0, 0, 0,
867 iscsi_co_generic_cb, &iTask,
868 (struct scsi_iovec *)iov->iov, iov->niov);
869 } else {
870 iTask.task = iscsi_read10_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
871 num_sectors * iscsilun->block_size,
872 iscsilun->block_size,
873 0, 0, 0, 0, 0,
874 iscsi_co_generic_cb, &iTask,
875 (struct scsi_iovec *)iov->iov, iov->niov);
876 }
877#else
063c3378
PL
878 iTask.task = iscsi_read16_task(iscsilun->iscsi, iscsilun->lun, lba,
879 num_sectors * iscsilun->block_size,
880 iscsilun->block_size, 0, 0, 0, 0, 0,
881 iscsi_co_generic_cb, &iTask);
9281fe9e 882 } else {
063c3378
PL
883 iTask.task = iscsi_read10_task(iscsilun->iscsi, iscsilun->lun, lba,
884 num_sectors * iscsilun->block_size,
219c2521 885 iscsilun->block_size,
219c2521 886 0, 0, 0, 0, 0,
063c3378 887 iscsi_co_generic_cb, &iTask);
f4dfa67f 888 }
583ec22e 889#endif
063c3378 890 if (iTask.task == NULL) {
f6eb0b31 891 qemu_mutex_unlock(&iscsilun->mutex);
92397116 892 return -ENOMEM;
c589b249 893 }
583ec22e 894#if LIBISCSI_API_VERSION < (20160603)
063c3378 895 scsi_task_set_iov_in(iTask.task, (struct scsi_iovec *) iov->iov, iov->niov);
583ec22e 896#endif
c589b249 897
66e75c03 898 iscsi_co_wait_for_task(&iTask, iscsilun);
063c3378
PL
899 if (iTask.task != NULL) {
900 scsi_free_scsi_task(iTask.task);
901 iTask.task = NULL;
c589b249
RS
902 }
903
063c3378 904 if (iTask.do_retry) {
837c3901 905 iTask.complete = 0;
063c3378 906 goto retry;
c589b249
RS
907 }
908
063c3378 909 if (iTask.status != SCSI_STATUS_GOOD) {
e38bc234
PL
910 error_report("iSCSI READ10/16 failed at lba %" PRIu64 ": %s",
911 lba, iTask.err_str);
912 r = iTask.err_code;
1dde716e
PL
913 }
914
e38bc234
PL
915 qemu_mutex_unlock(&iscsilun->mutex);
916 g_free(iTask.err_str);
917 return r;
1dde716e
PL
918}
919
063c3378 920static int coroutine_fn iscsi_co_flush(BlockDriverState *bs)
1dde716e
PL
921{
922 IscsiLun *iscsilun = bs->opaque;
063c3378 923 struct IscsiTask iTask;
e38bc234 924 int r = 0;
1dde716e 925
73b5394e 926 iscsi_co_init_iscsitask(iscsilun, &iTask);
d045c466 927 qemu_mutex_lock(&iscsilun->mutex);
063c3378
PL
928retry:
929 if (iscsi_synchronizecache10_task(iscsilun->iscsi, iscsilun->lun, 0, 0, 0,
930 0, iscsi_co_generic_cb, &iTask) == NULL) {
f6eb0b31 931 qemu_mutex_unlock(&iscsilun->mutex);
92397116 932 return -ENOMEM;
063c3378 933 }
1dde716e 934
66e75c03 935 iscsi_co_wait_for_task(&iTask, iscsilun);
1dde716e 936
063c3378
PL
937 if (iTask.task != NULL) {
938 scsi_free_scsi_task(iTask.task);
939 iTask.task = NULL;
c589b249
RS
940 }
941
063c3378 942 if (iTask.do_retry) {
837c3901 943 iTask.complete = 0;
063c3378
PL
944 goto retry;
945 }
c589b249 946
063c3378 947 if (iTask.status != SCSI_STATUS_GOOD) {
e38bc234
PL
948 error_report("iSCSI SYNCHRONIZECACHE10 failed: %s", iTask.err_str);
949 r = iTask.err_code;
063c3378
PL
950 }
951
e38bc234
PL
952 qemu_mutex_unlock(&iscsilun->mutex);
953 g_free(iTask.err_str);
954 return r;
c589b249
RS
955}
956
98392453 957#ifdef __linux__
d045c466 958/* Called (via iscsi_service) with QemuMutex held. */
98392453
RS
959static void
960iscsi_aio_ioctl_cb(struct iscsi_context *iscsi, int status,
961 void *command_data, void *opaque)
962{
963 IscsiAIOCB *acb = opaque;
964
88e94fd2
SH
965 if (status == SCSI_STATUS_CANCELLED) {
966 if (!acb->bh) {
967 acb->status = -ECANCELED;
968 iscsi_schedule_bh(acb);
969 }
970 return;
971 }
972
98392453
RS
973 acb->status = 0;
974 if (status < 0) {
975 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
976 iscsi_get_error(iscsi));
e01dd3da 977 acb->status = iscsi_translate_sense(&acb->task->sense);
98392453
RS
978 }
979
980 acb->ioh->driver_status = 0;
981 acb->ioh->host_status = 0;
982 acb->ioh->resid = 0;
644c6869 983 acb->ioh->status = status;
98392453
RS
984
985#define SG_ERR_DRIVER_SENSE 0x08
986
987 if (status == SCSI_STATUS_CHECK_CONDITION && acb->task->datain.size >= 2) {
988 int ss;
989
990 acb->ioh->driver_status |= SG_ERR_DRIVER_SENSE;
991
992 acb->ioh->sb_len_wr = acb->task->datain.size - 2;
993 ss = (acb->ioh->mx_sb_len >= acb->ioh->sb_len_wr) ?
994 acb->ioh->mx_sb_len : acb->ioh->sb_len_wr;
995 memcpy(acb->ioh->sbp, &acb->task->datain.data[2], ss);
996 }
997
cfb3f506 998 iscsi_schedule_bh(acb);
98392453
RS
999}
1000
4bb17ab5
FZ
1001static void iscsi_ioctl_bh_completion(void *opaque)
1002{
1003 IscsiAIOCB *acb = opaque;
1004
1005 qemu_bh_delete(acb->bh);
1006 acb->common.cb(acb->common.opaque, acb->ret);
1007 qemu_aio_unref(acb);
1008}
1009
1010static void iscsi_ioctl_handle_emulated(IscsiAIOCB *acb, int req, void *buf)
1011{
1012 BlockDriverState *bs = acb->common.bs;
1013 IscsiLun *iscsilun = bs->opaque;
1014 int ret = 0;
1015
1016 switch (req) {
1017 case SG_GET_VERSION_NUM:
1018 *(int *)buf = 30000;
1019 break;
1020 case SG_GET_SCSI_ID:
1021 ((struct sg_scsi_id *)buf)->scsi_type = iscsilun->type;
1022 break;
1023 default:
1024 ret = -EINVAL;
1025 }
1026 assert(!acb->bh);
1027 acb->bh = aio_bh_new(bdrv_get_aio_context(bs),
1028 iscsi_ioctl_bh_completion, acb);
1029 acb->ret = ret;
1030 qemu_bh_schedule(acb->bh);
1031}
1032
7c84b1b8 1033static BlockAIOCB *iscsi_aio_ioctl(BlockDriverState *bs,
98392453 1034 unsigned long int req, void *buf,
097310b5 1035 BlockCompletionFunc *cb, void *opaque)
98392453
RS
1036{
1037 IscsiLun *iscsilun = bs->opaque;
1038 struct iscsi_context *iscsi = iscsilun->iscsi;
1039 struct iscsi_data data;
1040 IscsiAIOCB *acb;
1041
d7331bed 1042 acb = qemu_aio_get(&iscsi_aiocb_info, bs, cb, opaque);
98392453
RS
1043
1044 acb->iscsilun = iscsilun;
1bd075f2
PB
1045 acb->bh = NULL;
1046 acb->status = -EINPROGRESS;
98392453 1047 acb->ioh = buf;
c1004487 1048 acb->cancelled = false;
98392453 1049
4bb17ab5
FZ
1050 if (req != SG_IO) {
1051 iscsi_ioctl_handle_emulated(acb, req, buf);
1052 return &acb->common;
1053 }
1054
a6b3167f
PL
1055 if (acb->ioh->cmd_len > SCSI_CDB_MAX_SIZE) {
1056 error_report("iSCSI: ioctl error CDB exceeds max size (%d > %d)",
1057 acb->ioh->cmd_len, SCSI_CDB_MAX_SIZE);
1058 qemu_aio_unref(acb);
1059 return NULL;
1060 }
1061
98392453
RS
1062 acb->task = malloc(sizeof(struct scsi_task));
1063 if (acb->task == NULL) {
1064 error_report("iSCSI: Failed to allocate task for scsi command. %s",
1065 iscsi_get_error(iscsi));
8007429a 1066 qemu_aio_unref(acb);
98392453
RS
1067 return NULL;
1068 }
1069 memset(acb->task, 0, sizeof(struct scsi_task));
1070
1071 switch (acb->ioh->dxfer_direction) {
1072 case SG_DXFER_TO_DEV:
1073 acb->task->xfer_dir = SCSI_XFER_WRITE;
1074 break;
1075 case SG_DXFER_FROM_DEV:
1076 acb->task->xfer_dir = SCSI_XFER_READ;
1077 break;
1078 default:
1079 acb->task->xfer_dir = SCSI_XFER_NONE;
1080 break;
1081 }
1082
1083 acb->task->cdb_size = acb->ioh->cmd_len;
1084 memcpy(&acb->task->cdb[0], acb->ioh->cmdp, acb->ioh->cmd_len);
1085 acb->task->expxferlen = acb->ioh->dxfer_len;
1086
0a53f010 1087 data.size = 0;
d045c466 1088 qemu_mutex_lock(&iscsilun->mutex);
98392453 1089 if (acb->task->xfer_dir == SCSI_XFER_WRITE) {
0a53f010
RS
1090 if (acb->ioh->iovec_count == 0) {
1091 data.data = acb->ioh->dxferp;
1092 data.size = acb->ioh->dxfer_len;
1093 } else {
0a53f010
RS
1094 scsi_task_set_iov_out(acb->task,
1095 (struct scsi_iovec *) acb->ioh->dxferp,
1096 acb->ioh->iovec_count);
0a53f010 1097 }
98392453 1098 }
0a53f010 1099
98392453
RS
1100 if (iscsi_scsi_command_async(iscsi, iscsilun->lun, acb->task,
1101 iscsi_aio_ioctl_cb,
0a53f010 1102 (data.size > 0) ? &data : NULL,
98392453 1103 acb) != 0) {
d045c466 1104 qemu_mutex_unlock(&iscsilun->mutex);
98392453 1105 scsi_free_scsi_task(acb->task);
8007429a 1106 qemu_aio_unref(acb);
98392453
RS
1107 return NULL;
1108 }
1109
1110 /* tell libiscsi to read straight into the buffer we got from ioctl */
1111 if (acb->task->xfer_dir == SCSI_XFER_READ) {
0a53f010
RS
1112 if (acb->ioh->iovec_count == 0) {
1113 scsi_task_add_data_in_buffer(acb->task,
1114 acb->ioh->dxfer_len,
1115 acb->ioh->dxferp);
1116 } else {
0a53f010
RS
1117 scsi_task_set_iov_in(acb->task,
1118 (struct scsi_iovec *) acb->ioh->dxferp,
1119 acb->ioh->iovec_count);
0a53f010 1120 }
98392453
RS
1121 }
1122
1123 iscsi_set_events(iscsilun);
d045c466 1124 qemu_mutex_unlock(&iscsilun->mutex);
98392453
RS
1125
1126 return &acb->common;
1127}
1128
98392453
RS
1129#endif
1130
c589b249
RS
1131static int64_t
1132iscsi_getlength(BlockDriverState *bs)
1133{
1134 IscsiLun *iscsilun = bs->opaque;
1135 int64_t len;
1136
1137 len = iscsilun->num_blocks;
1138 len *= iscsilun->block_size;
1139
1140 return len;
1141}
1142
65f3e339 1143static int
f5a5ca79 1144coroutine_fn iscsi_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
65f3e339
PL
1145{
1146 IscsiLun *iscsilun = bs->opaque;
1147 struct IscsiTask iTask;
1148 struct unmap_list list;
d045c466 1149 int r = 0;
65f3e339 1150
f5a5ca79 1151 if (!is_byte_request_lun_aligned(offset, bytes, iscsilun)) {
49228d1e
EB
1152 return -ENOTSUP;
1153 }
65f3e339
PL
1154
1155 if (!iscsilun->lbp.lbpu) {
1156 /* UNMAP is not supported by the target */
1157 return 0;
1158 }
1159
97c7e85c 1160 list.lba = offset / iscsilun->block_size;
f5a5ca79 1161 list.num = bytes / iscsilun->block_size;
65f3e339 1162
01a6a238 1163 iscsi_co_init_iscsitask(iscsilun, &iTask);
d045c466 1164 qemu_mutex_lock(&iscsilun->mutex);
65f3e339 1165retry:
01a6a238 1166 if (iscsi_unmap_task(iscsilun->iscsi, iscsilun->lun, 0, 0, &list, 1,
97c7e85c 1167 iscsi_co_generic_cb, &iTask) == NULL) {
d045c466
PB
1168 r = -ENOMEM;
1169 goto out_unlock;
01a6a238 1170 }
65f3e339 1171
66e75c03 1172 iscsi_co_wait_for_task(&iTask, iscsilun);
65f3e339 1173
01a6a238
PL
1174 if (iTask.task != NULL) {
1175 scsi_free_scsi_task(iTask.task);
1176 iTask.task = NULL;
1177 }
65f3e339 1178
01a6a238 1179 if (iTask.do_retry) {
837c3901 1180 iTask.complete = 0;
01a6a238
PL
1181 goto retry;
1182 }
65f3e339 1183
04a408fb 1184 iscsi_allocmap_set_invalid(iscsilun, offset, bytes);
aef172ff 1185
01a6a238
PL
1186 if (iTask.status == SCSI_STATUS_CHECK_CONDITION) {
1187 /* the target might fail with a check condition if it
1188 is not happy with the alignment of the UNMAP request
1189 we silently fail in this case */
d045c466 1190 goto out_unlock;
01a6a238 1191 }
65f3e339 1192
01a6a238 1193 if (iTask.status != SCSI_STATUS_GOOD) {
e38bc234
PL
1194 error_report("iSCSI UNMAP failed at lba %" PRIu64 ": %s",
1195 list.lba, iTask.err_str);
d045c466
PB
1196 r = iTask.err_code;
1197 goto out_unlock;
65f3e339
PL
1198 }
1199
d045c466
PB
1200out_unlock:
1201 qemu_mutex_unlock(&iscsilun->mutex);
e38bc234 1202 g_free(iTask.err_str);
d045c466 1203 return r;
65f3e339
PL
1204}
1205
d4cd9615 1206static int
94d047a3 1207coroutine_fn iscsi_co_pwrite_zeroes(BlockDriverState *bs, int64_t offset,
f5a5ca79 1208 int bytes, BdrvRequestFlags flags)
d4cd9615
PL
1209{
1210 IscsiLun *iscsilun = bs->opaque;
1211 struct IscsiTask iTask;
1212 uint64_t lba;
1213 uint32_t nb_blocks;
9281fe9e 1214 bool use_16_for_ws = iscsilun->use_16_for_rw;
d045c466 1215 int r = 0;
d4cd9615 1216
f5a5ca79 1217 if (!is_byte_request_lun_aligned(offset, bytes, iscsilun)) {
94d047a3 1218 return -ENOTSUP;
d4cd9615
PL
1219 }
1220
9281fe9e
PL
1221 if (flags & BDRV_REQ_MAY_UNMAP) {
1222 if (!use_16_for_ws && !iscsilun->lbp.lbpws10) {
1223 /* WRITESAME10 with UNMAP is unsupported try WRITESAME16 */
1224 use_16_for_ws = true;
1225 }
1226 if (use_16_for_ws && !iscsilun->lbp.lbpws) {
1227 /* WRITESAME16 with UNMAP is not supported by the target,
1228 * fall back and try WRITESAME10/16 without UNMAP */
1229 flags &= ~BDRV_REQ_MAY_UNMAP;
1230 use_16_for_ws = iscsilun->use_16_for_rw;
1231 }
fa6252b0
PB
1232 }
1233
dbe5c58f 1234 if (!(flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->has_write_same) {
9281fe9e 1235 /* WRITESAME without UNMAP is not supported by the target */
d4cd9615
PL
1236 return -ENOTSUP;
1237 }
1238
94d047a3 1239 lba = offset / iscsilun->block_size;
f5a5ca79 1240 nb_blocks = bytes / iscsilun->block_size;
d4cd9615
PL
1241
1242 if (iscsilun->zeroblock == NULL) {
4d5a3f88
KW
1243 iscsilun->zeroblock = g_try_malloc0(iscsilun->block_size);
1244 if (iscsilun->zeroblock == NULL) {
1245 return -ENOMEM;
1246 }
d4cd9615
PL
1247 }
1248
d045c466 1249 qemu_mutex_lock(&iscsilun->mutex);
d4cd9615
PL
1250 iscsi_co_init_iscsitask(iscsilun, &iTask);
1251retry:
9281fe9e
PL
1252 if (use_16_for_ws) {
1253 iTask.task = iscsi_writesame16_task(iscsilun->iscsi, iscsilun->lun, lba,
1254 iscsilun->zeroblock, iscsilun->block_size,
1255 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
1256 0, 0, iscsi_co_generic_cb, &iTask);
1257 } else {
1258 iTask.task = iscsi_writesame10_task(iscsilun->iscsi, iscsilun->lun, lba,
1259 iscsilun->zeroblock, iscsilun->block_size,
1260 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
1261 0, 0, iscsi_co_generic_cb, &iTask);
1262 }
1263 if (iTask.task == NULL) {
f6eb0b31 1264 qemu_mutex_unlock(&iscsilun->mutex);
92397116 1265 return -ENOMEM;
d4cd9615
PL
1266 }
1267
66e75c03 1268 iscsi_co_wait_for_task(&iTask, iscsilun);
d4cd9615 1269
d9738fd2
PL
1270 if (iTask.status == SCSI_STATUS_CHECK_CONDITION &&
1271 iTask.task->sense.key == SCSI_SENSE_ILLEGAL_REQUEST &&
27898a5d
PB
1272 (iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE ||
1273 iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB)) {
d9738fd2
PL
1274 /* WRITE SAME is not supported by the target */
1275 iscsilun->has_write_same = false;
1276 scsi_free_scsi_task(iTask.task);
d045c466
PB
1277 r = -ENOTSUP;
1278 goto out_unlock;
d9738fd2
PL
1279 }
1280
d4cd9615
PL
1281 if (iTask.task != NULL) {
1282 scsi_free_scsi_task(iTask.task);
1283 iTask.task = NULL;
1284 }
1285
1286 if (iTask.do_retry) {
837c3901 1287 iTask.complete = 0;
d4cd9615
PL
1288 goto retry;
1289 }
1290
1291 if (iTask.status != SCSI_STATUS_GOOD) {
04a408fb 1292 iscsi_allocmap_set_invalid(iscsilun, offset, bytes);
e38bc234
PL
1293 error_report("iSCSI WRITESAME10/16 failed at lba %" PRIu64 ": %s",
1294 lba, iTask.err_str);
d045c466
PB
1295 r = iTask.err_code;
1296 goto out_unlock;
d4cd9615
PL
1297 }
1298
b03c3805 1299 if (flags & BDRV_REQ_MAY_UNMAP) {
04a408fb 1300 iscsi_allocmap_set_invalid(iscsilun, offset, bytes);
b03c3805 1301 } else {
04a408fb 1302 iscsi_allocmap_set_allocated(iscsilun, offset, bytes);
b03c3805
PL
1303 }
1304
d045c466
PB
1305out_unlock:
1306 qemu_mutex_unlock(&iscsilun->mutex);
e38bc234 1307 g_free(iTask.err_str);
d045c466 1308 return r;
d4cd9615
PL
1309}
1310
43171420 1311static void apply_chap(struct iscsi_context *iscsi, QemuOpts *opts,
f2917853 1312 Error **errp)
f9dadc98 1313{
f9dadc98
RS
1314 const char *user = NULL;
1315 const char *password = NULL;
b189346e
DB
1316 const char *secretid;
1317 char *secret = NULL;
f9dadc98 1318
f9dadc98
RS
1319 user = qemu_opt_get(opts, "user");
1320 if (!user) {
f2917853 1321 return;
f9dadc98
RS
1322 }
1323
b189346e 1324 secretid = qemu_opt_get(opts, "password-secret");
f9dadc98 1325 password = qemu_opt_get(opts, "password");
b189346e
DB
1326 if (secretid && password) {
1327 error_setg(errp, "'password' and 'password-secret' properties are "
1328 "mutually exclusive");
1329 return;
1330 }
1331 if (secretid) {
1332 secret = qcrypto_secret_lookup_as_utf8(secretid, errp);
1333 if (!secret) {
1334 return;
1335 }
1336 password = secret;
1337 } else if (!password) {
f2917853
PB
1338 error_setg(errp, "CHAP username specified but no password was given");
1339 return;
f9dadc98
RS
1340 }
1341
1342 if (iscsi_set_initiator_username_pwd(iscsi, user, password)) {
f2917853 1343 error_setg(errp, "Failed to set initiator username and password");
f9dadc98 1344 }
b189346e
DB
1345
1346 g_free(secret);
f9dadc98
RS
1347}
1348
81aa2a0f 1349static void apply_header_digest(struct iscsi_context *iscsi, QemuOpts *opts,
f2917853 1350 Error **errp)
f9dadc98 1351{
f9dadc98
RS
1352 const char *digest = NULL;
1353
f9dadc98
RS
1354 digest = qemu_opt_get(opts, "header-digest");
1355 if (!digest) {
81aa2a0f 1356 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
31eb1202 1357 } else if (!strcmp(digest, "crc32c")) {
f9dadc98 1358 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C);
31eb1202 1359 } else if (!strcmp(digest, "none")) {
f9dadc98 1360 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE);
31eb1202 1361 } else if (!strcmp(digest, "crc32c-none")) {
f9dadc98 1362 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C_NONE);
31eb1202 1363 } else if (!strcmp(digest, "none-crc32c")) {
f9dadc98
RS
1364 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
1365 } else {
f2917853 1366 error_setg(errp, "Invalid header-digest setting : %s", digest);
f9dadc98
RS
1367 }
1368}
1369
d4e79929 1370static char *get_initiator_name(QemuOpts *opts)
f9dadc98 1371{
5accc840
PB
1372 const char *name;
1373 char *iscsi_name;
1374 UuidInfo *uuid_info;
f9dadc98 1375
d4e79929
KW
1376 name = qemu_opt_get(opts, "initiator-name");
1377 if (name) {
1378 return g_strdup(name);
f9dadc98
RS
1379 }
1380
5accc840
PB
1381 uuid_info = qmp_query_uuid(NULL);
1382 if (strcmp(uuid_info->UUID, UUID_NONE) == 0) {
1383 name = qemu_get_vm_name();
f2ef4a6d 1384 } else {
5accc840 1385 name = uuid_info->UUID;
f9dadc98 1386 }
5accc840
PB
1387 iscsi_name = g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
1388 name ? ":" : "", name ? name : "");
1389 qapi_free_UuidInfo(uuid_info);
1390 return iscsi_name;
f9dadc98
RS
1391}
1392
5b5d34ec
PL
1393static void iscsi_nop_timed_event(void *opaque)
1394{
1395 IscsiLun *iscsilun = opaque;
1396
d045c466 1397 qemu_mutex_lock(&iscsilun->mutex);
5dd7a535 1398 if (iscsi_get_nops_in_flight(iscsilun->iscsi) >= MAX_NOP_FAILURES) {
5b5d34ec 1399 error_report("iSCSI: NOP timeout. Reconnecting...");
5dd7a535
PL
1400 iscsilun->request_timed_out = true;
1401 } else if (iscsi_nop_out_async(iscsilun->iscsi, NULL, NULL, 0, NULL) != 0) {
5b5d34ec 1402 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
2f47da5f 1403 goto out;
5b5d34ec
PL
1404 }
1405
bc72ad67 1406 timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
5b5d34ec 1407 iscsi_set_events(iscsilun);
2f47da5f
PB
1408
1409out:
d045c466 1410 qemu_mutex_unlock(&iscsilun->mutex);
5b5d34ec 1411}
5b5d34ec 1412
f2917853 1413static void iscsi_readcapacity_sync(IscsiLun *iscsilun, Error **errp)
cb1b83e7
PL
1414{
1415 struct scsi_task *task = NULL;
1416 struct scsi_readcapacity10 *rc10 = NULL;
1417 struct scsi_readcapacity16 *rc16 = NULL;
cb1b83e7
PL
1418 int retries = ISCSI_CMD_RETRIES;
1419
1288844e
PB
1420 do {
1421 if (task != NULL) {
1422 scsi_free_scsi_task(task);
1423 task = NULL;
cb1b83e7 1424 }
1288844e
PB
1425
1426 switch (iscsilun->type) {
1427 case TYPE_DISK:
1428 task = iscsi_readcapacity16_sync(iscsilun->iscsi, iscsilun->lun);
1429 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1430 rc16 = scsi_datain_unmarshall(task);
1431 if (rc16 == NULL) {
f2917853 1432 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity16 data.");
1288844e
PB
1433 } else {
1434 iscsilun->block_size = rc16->block_length;
1435 iscsilun->num_blocks = rc16->returned_lba + 1;
0a386e48
PL
1436 iscsilun->lbpme = !!rc16->lbpme;
1437 iscsilun->lbprz = !!rc16->lbprz;
9281fe9e 1438 iscsilun->use_16_for_rw = (rc16->returned_lba > 0xffffffff);
1288844e 1439 }
1cb6d137 1440 break;
1288844e 1441 }
1cb6d137
ZL
1442 if (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
1443 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
1444 break;
1445 }
1446 /* Fall through and try READ CAPACITY(10) instead. */
1288844e
PB
1447 case TYPE_ROM:
1448 task = iscsi_readcapacity10_sync(iscsilun->iscsi, iscsilun->lun, 0, 0);
1449 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1450 rc10 = scsi_datain_unmarshall(task);
1451 if (rc10 == NULL) {
f2917853 1452 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity10 data.");
1288844e
PB
1453 } else {
1454 iscsilun->block_size = rc10->block_size;
1455 if (rc10->lba == 0) {
1456 /* blank disk loaded */
1457 iscsilun->num_blocks = 0;
1458 } else {
1459 iscsilun->num_blocks = rc10->lba + 1;
1460 }
1461 }
1462 }
1463 break;
1464 default:
f2917853 1465 return;
cb1b83e7 1466 }
1288844e
PB
1467 } while (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
1468 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION
1469 && retries-- > 0);
cb1b83e7 1470
1288844e 1471 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
240125bc 1472 error_setg(errp, "iSCSI: failed to send readcapacity10/16 command");
6d1f252d
PL
1473 } else if (!iscsilun->block_size ||
1474 iscsilun->block_size % BDRV_SECTOR_SIZE) {
1475 error_setg(errp, "iSCSI: the target returned an invalid "
1476 "block size of %d.", iscsilun->block_size);
1288844e 1477 }
cb1b83e7
PL
1478 if (task) {
1479 scsi_free_scsi_task(task);
1480 }
cb1b83e7
PL
1481}
1482
35cb1748 1483static struct scsi_task *iscsi_do_inquiry(struct iscsi_context *iscsi, int lun,
24d3bd67 1484 int evpd, int pc, void **inq, Error **errp)
35cb1748
PB
1485{
1486 int full_size;
1487 struct scsi_task *task = NULL;
1488 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, 64);
1489 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1490 goto fail;
1491 }
1492 full_size = scsi_datain_getfullsize(task);
1493 if (full_size > task->datain.size) {
1494 scsi_free_scsi_task(task);
1495
1496 /* we need more data for the full list */
1497 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, full_size);
f18a7cbb
PL
1498 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1499 goto fail;
1500 }
35cb1748 1501 }
f18a7cbb 1502
24d3bd67
PL
1503 *inq = scsi_datain_unmarshall(task);
1504 if (*inq == NULL) {
1505 error_setg(errp, "iSCSI: failed to unmarshall inquiry datain blob");
172fc4dd 1506 goto fail_with_err;
24d3bd67
PL
1507 }
1508
35cb1748 1509 return task;
f18a7cbb
PL
1510
1511fail:
172fc4dd
MA
1512 error_setg(errp, "iSCSI: Inquiry command failed : %s",
1513 iscsi_get_error(iscsi));
1514fail_with_err:
24d3bd67 1515 if (task != NULL) {
35cb1748 1516 scsi_free_scsi_task(task);
35cb1748
PB
1517 }
1518 return NULL;
f18a7cbb
PL
1519}
1520
80cf6257
SH
1521static void iscsi_detach_aio_context(BlockDriverState *bs)
1522{
1523 IscsiLun *iscsilun = bs->opaque;
1524
dca21ef2 1525 aio_set_fd_handler(iscsilun->aio_context, iscsi_get_fd(iscsilun->iscsi),
f6a51c84 1526 false, NULL, NULL, NULL, NULL);
80cf6257
SH
1527 iscsilun->events = 0;
1528
1529 if (iscsilun->nop_timer) {
1530 timer_del(iscsilun->nop_timer);
1531 timer_free(iscsilun->nop_timer);
1532 iscsilun->nop_timer = NULL;
1533 }
05b685fb
PL
1534 if (iscsilun->event_timer) {
1535 timer_del(iscsilun->event_timer);
1536 timer_free(iscsilun->event_timer);
1537 iscsilun->event_timer = NULL;
1538 }
80cf6257
SH
1539}
1540
1541static void iscsi_attach_aio_context(BlockDriverState *bs,
1542 AioContext *new_context)
1543{
1544 IscsiLun *iscsilun = bs->opaque;
1545
1546 iscsilun->aio_context = new_context;
1547 iscsi_set_events(iscsilun);
1548
80cf6257
SH
1549 /* Set up a timer for sending out iSCSI NOPs */
1550 iscsilun->nop_timer = aio_timer_new(iscsilun->aio_context,
1551 QEMU_CLOCK_REALTIME, SCALE_MS,
1552 iscsi_nop_timed_event, iscsilun);
1553 timer_mod(iscsilun->nop_timer,
1554 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
05b685fb 1555
5dd7a535
PL
1556 /* Set up a timer for periodic calls to iscsi_set_events and to
1557 * scan for command timeout */
05b685fb
PL
1558 iscsilun->event_timer = aio_timer_new(iscsilun->aio_context,
1559 QEMU_CLOCK_REALTIME, SCALE_MS,
5dd7a535
PL
1560 iscsi_timed_check_events, iscsilun);
1561 timer_mod(iscsilun->event_timer,
1562 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + EVENT_INTERVAL);
80cf6257
SH
1563}
1564
7191f208 1565static void iscsi_modesense_sync(IscsiLun *iscsilun)
c1d4096b
FZ
1566{
1567 struct scsi_task *task;
1568 struct scsi_mode_sense *ms = NULL;
7191f208 1569 iscsilun->write_protected = false;
752ce451 1570 iscsilun->dpofua = false;
c1d4096b
FZ
1571
1572 task = iscsi_modesense6_sync(iscsilun->iscsi, iscsilun->lun,
1573 1, SCSI_MODESENSE_PC_CURRENT,
1574 0x3F, 0, 255);
1575 if (task == NULL) {
1576 error_report("iSCSI: Failed to send MODE_SENSE(6) command: %s",
1577 iscsi_get_error(iscsilun->iscsi));
1578 goto out;
1579 }
1580
1581 if (task->status != SCSI_STATUS_GOOD) {
1582 error_report("iSCSI: Failed MODE_SENSE(6), LUN assumed writable");
1583 goto out;
1584 }
1585 ms = scsi_datain_unmarshall(task);
1586 if (!ms) {
1587 error_report("iSCSI: Failed to unmarshall MODE_SENSE(6) data: %s",
1588 iscsi_get_error(iscsilun->iscsi));
1589 goto out;
1590 }
7191f208 1591 iscsilun->write_protected = ms->device_specific_parameter & 0x80;
752ce451 1592 iscsilun->dpofua = ms->device_specific_parameter & 0x10;
c1d4096b
FZ
1593
1594out:
1595 if (task) {
1596 scsi_free_scsi_task(task);
1597 }
c1d4096b
FZ
1598}
1599
43171420
KW
1600static void iscsi_parse_iscsi_option(const char *target, QDict *options)
1601{
1602 QemuOptsList *list;
1603 QemuOpts *opts;
81aa2a0f 1604 const char *user, *password, *password_secret, *initiator_name,
1d560104 1605 *header_digest, *timeout;
43171420
KW
1606
1607 list = qemu_find_opts("iscsi");
1608 if (!list) {
1609 return;
1610 }
1611
1612 opts = qemu_opts_find(list, target);
1613 if (opts == NULL) {
1614 opts = QTAILQ_FIRST(&list->head);
1615 if (!opts) {
1616 return;
1617 }
1618 }
1619
1620 user = qemu_opt_get(opts, "user");
1621 if (user) {
1622 qdict_set_default_str(options, "user", user);
1623 }
1624
1625 password = qemu_opt_get(opts, "password");
1626 if (password) {
1627 qdict_set_default_str(options, "password", password);
1628 }
1629
1630 password_secret = qemu_opt_get(opts, "password-secret");
1631 if (password_secret) {
1632 qdict_set_default_str(options, "password-secret", password_secret);
1633 }
d4e79929
KW
1634
1635 initiator_name = qemu_opt_get(opts, "initiator-name");
1636 if (initiator_name) {
1637 qdict_set_default_str(options, "initiator-name", initiator_name);
1638 }
81aa2a0f
KW
1639
1640 header_digest = qemu_opt_get(opts, "header-digest");
1641 if (header_digest) {
31eb1202
KW
1642 /* -iscsi takes upper case values, but QAPI only supports lower case
1643 * enum constant names, so we have to convert here. */
1644 char *qapi_value = g_ascii_strdown(header_digest, -1);
1645 qdict_set_default_str(options, "header-digest", qapi_value);
1646 g_free(qapi_value);
81aa2a0f 1647 }
1d560104
KW
1648
1649 timeout = qemu_opt_get(opts, "timeout");
1650 if (timeout) {
1651 qdict_set_default_str(options, "timeout", timeout);
1652 }
43171420
KW
1653}
1654
c589b249
RS
1655/*
1656 * We support iscsi url's on the form
1657 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
1658 */
d5895fcb
KW
1659static void iscsi_parse_filename(const char *filename, QDict *options,
1660 Error **errp)
1661{
1662 struct iscsi_url *iscsi_url;
1663 const char *transport_name;
1664 char *lun_str;
1665
1666 iscsi_url = iscsi_parse_full_url(NULL, filename);
1667 if (iscsi_url == NULL) {
1668 error_setg(errp, "Failed to parse URL : %s", filename);
1669 return;
1670 }
1671
1672#if LIBISCSI_API_VERSION >= (20160603)
1673 switch (iscsi_url->transport) {
1674 case TCP_TRANSPORT:
1675 transport_name = "tcp";
1676 break;
1677 case ISER_TRANSPORT:
1678 transport_name = "iser";
1679 break;
1680 default:
1681 error_setg(errp, "Unknown transport type (%d)",
1682 iscsi_url->transport);
1683 return;
1684 }
1685#else
1686 transport_name = "tcp";
1687#endif
1688
1689 qdict_set_default_str(options, "transport", transport_name);
1690 qdict_set_default_str(options, "portal", iscsi_url->portal);
1691 qdict_set_default_str(options, "target", iscsi_url->target);
1692
1693 lun_str = g_strdup_printf("%d", iscsi_url->lun);
1694 qdict_set_default_str(options, "lun", lun_str);
1695 g_free(lun_str);
1696
43171420
KW
1697 /* User/password from -iscsi take precedence over those from the URL */
1698 iscsi_parse_iscsi_option(iscsi_url->target, options);
1699
d5895fcb
KW
1700 if (iscsi_url->user[0] != '\0') {
1701 qdict_set_default_str(options, "user", iscsi_url->user);
1702 qdict_set_default_str(options, "password", iscsi_url->passwd);
1703 }
1704
1705 iscsi_destroy_url(iscsi_url);
1706}
1707
d5895fcb
KW
1708static QemuOptsList runtime_opts = {
1709 .name = "iscsi",
1710 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
1711 .desc = {
1712 {
1713 .name = "transport",
1714 .type = QEMU_OPT_STRING,
1715 },
1716 {
1717 .name = "portal",
1718 .type = QEMU_OPT_STRING,
1719 },
1720 {
1721 .name = "target",
1722 .type = QEMU_OPT_STRING,
1723 },
1724 {
1725 .name = "user",
1726 .type = QEMU_OPT_STRING,
1727 },
1728 {
1729 .name = "password",
1730 .type = QEMU_OPT_STRING,
1731 },
43171420
KW
1732 {
1733 .name = "password-secret",
1734 .type = QEMU_OPT_STRING,
1735 },
d5895fcb
KW
1736 {
1737 .name = "lun",
1738 .type = QEMU_OPT_NUMBER,
1739 },
d4e79929
KW
1740 {
1741 .name = "initiator-name",
1742 .type = QEMU_OPT_STRING,
1743 },
81aa2a0f
KW
1744 {
1745 .name = "header-digest",
1746 .type = QEMU_OPT_STRING,
1747 },
1d560104
KW
1748 {
1749 .name = "timeout",
1750 .type = QEMU_OPT_NUMBER,
1751 },
d5895fcb
KW
1752 { /* end of list */ }
1753 },
1754};
1755
cc9743c2
FZ
1756static void iscsi_save_designator(IscsiLun *lun,
1757 struct scsi_inquiry_device_identification *inq_di)
1758{
1759 struct scsi_inquiry_device_designator *desig, *copy = NULL;
1760
1761 for (desig = inq_di->designators; desig; desig = desig->next) {
1762 if (desig->association ||
1763 desig->designator_type > SCSI_DESIGNATOR_TYPE_NAA) {
1764 continue;
1765 }
1766 /* NAA works better than T10 vendor ID based designator. */
1767 if (!copy || copy->designator_type < desig->designator_type) {
1768 copy = desig;
1769 }
1770 }
1771 if (copy) {
1772 lun->dd = g_new(struct scsi_inquiry_device_designator, 1);
1773 *lun->dd = *copy;
1774 lun->dd->next = NULL;
1775 lun->dd->designator = g_malloc(copy->designator_length);
1776 memcpy(lun->dd->designator, copy->designator, copy->designator_length);
1777 }
1778}
1779
015a1036
HR
1780static int iscsi_open(BlockDriverState *bs, QDict *options, int flags,
1781 Error **errp)
c589b249
RS
1782{
1783 IscsiLun *iscsilun = bs->opaque;
1784 struct iscsi_context *iscsi = NULL;
e829b0bb
PL
1785 struct scsi_task *task = NULL;
1786 struct scsi_inquiry_standard *inq = NULL;
24d3bd67 1787 struct scsi_inquiry_supported_pages *inq_vpd;
f9dadc98 1788 char *initiator_name = NULL;
60beb341
KW
1789 QemuOpts *opts;
1790 Error *local_err = NULL;
deadbb8e 1791 const char *transport_name, *portal, *target;
d5895fcb
KW
1792#if LIBISCSI_API_VERSION >= (20160603)
1793 enum iscsi_transport_type transport;
1794#endif
1795 int i, ret = 0, timeout = 0, lun;
c589b249 1796
87ea75d5 1797 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
60beb341 1798 qemu_opts_absorb_qdict(opts, options, &local_err);
84d18f06 1799 if (local_err) {
f2917853 1800 error_propagate(errp, local_err);
60beb341
KW
1801 ret = -EINVAL;
1802 goto out;
1803 }
1804
d5895fcb
KW
1805 transport_name = qemu_opt_get(opts, "transport");
1806 portal = qemu_opt_get(opts, "portal");
1807 target = qemu_opt_get(opts, "target");
d5895fcb 1808 lun = qemu_opt_get_number(opts, "lun", 0);
60beb341 1809
d5895fcb
KW
1810 if (!transport_name || !portal || !target) {
1811 error_setg(errp, "Need all of transport, portal and target options");
1812 ret = -EINVAL;
1813 goto out;
1814 }
d5895fcb
KW
1815
1816 if (!strcmp(transport_name, "tcp")) {
1817#if LIBISCSI_API_VERSION >= (20160603)
1818 transport = TCP_TRANSPORT;
1819 } else if (!strcmp(transport_name, "iser")) {
1820 transport = ISER_TRANSPORT;
1821#else
1822 /* TCP is what older libiscsi versions always use */
1823#endif
1824 } else {
1825 error_setg(errp, "Unknown transport: %s", transport_name);
c589b249 1826 ret = -EINVAL;
b93c94f7 1827 goto out;
c589b249
RS
1828 }
1829
f9dadc98
RS
1830 memset(iscsilun, 0, sizeof(IscsiLun));
1831
d4e79929 1832 initiator_name = get_initiator_name(opts);
f9dadc98
RS
1833
1834 iscsi = iscsi_create_context(initiator_name);
1835 if (iscsi == NULL) {
f2917853 1836 error_setg(errp, "iSCSI: Failed to create iSCSI context.");
f9dadc98 1837 ret = -ENOMEM;
b93c94f7 1838 goto out;
f9dadc98 1839 }
e0ae4987 1840#if LIBISCSI_API_VERSION >= (20160603)
d5895fcb 1841 if (iscsi_init_transport(iscsi, transport)) {
e0ae4987
RS
1842 error_setg(errp, ("Error initializing transport."));
1843 ret = -EINVAL;
1844 goto out;
1845 }
1846#endif
d5895fcb 1847 if (iscsi_set_targetname(iscsi, target)) {
f2917853 1848 error_setg(errp, "iSCSI: Failed to set target name.");
c589b249 1849 ret = -EINVAL;
b93c94f7 1850 goto out;
c589b249
RS
1851 }
1852
f9dadc98 1853 /* check if we got CHAP username/password via the options */
43171420 1854 apply_chap(iscsi, opts, &local_err);
f2917853
PB
1855 if (local_err != NULL) {
1856 error_propagate(errp, local_err);
f9dadc98 1857 ret = -EINVAL;
b93c94f7 1858 goto out;
f9dadc98
RS
1859 }
1860
c589b249 1861 if (iscsi_set_session_type(iscsi, ISCSI_SESSION_NORMAL) != 0) {
f2917853 1862 error_setg(errp, "iSCSI: Failed to set session type to normal.");
c589b249 1863 ret = -EINVAL;
b93c94f7 1864 goto out;
c589b249
RS
1865 }
1866
f9dadc98 1867 /* check if we got HEADER_DIGEST via the options */
81aa2a0f 1868 apply_header_digest(iscsi, opts, &local_err);
f2917853
PB
1869 if (local_err != NULL) {
1870 error_propagate(errp, local_err);
1871 ret = -EINVAL;
1872 goto out;
1873 }
f9dadc98 1874
9049736e 1875 /* timeout handling is broken in libiscsi before 1.15.0 */
1d560104 1876 timeout = qemu_opt_get_number(opts, "timeout", 0);
583ec22e 1877#if LIBISCSI_API_VERSION >= 20150621
9049736e
PL
1878 iscsi_set_timeout(iscsi, timeout);
1879#else
1880 if (timeout) {
5197f445 1881 warn_report("iSCSI: ignoring timeout value for libiscsi <1.15.0");
9049736e
PL
1882 }
1883#endif
5dd7a535 1884
d5895fcb 1885 if (iscsi_full_connect_sync(iscsi, portal, lun) != 0) {
f2917853 1886 error_setg(errp, "iSCSI: Failed to connect to LUN : %s",
e829b0bb
PL
1887 iscsi_get_error(iscsi));
1888 ret = -EINVAL;
1889 goto out;
1890 }
c589b249
RS
1891
1892 iscsilun->iscsi = iscsi;
80cf6257 1893 iscsilun->aio_context = bdrv_get_aio_context(bs);
d5895fcb 1894 iscsilun->lun = lun;
24d3bd67 1895 iscsilun->has_write_same = true;
c589b249 1896
24d3bd67
PL
1897 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 0, 0,
1898 (void **) &inq, errp);
1899 if (task == NULL) {
c589b249 1900 ret = -EINVAL;
b93c94f7 1901 goto out;
c589b249 1902 }
e829b0bb 1903 iscsilun->type = inq->periperal_device_type;
24d3bd67
PL
1904 scsi_free_scsi_task(task);
1905 task = NULL;
e829b0bb 1906
7191f208 1907 iscsi_modesense_sync(iscsilun);
4df863f3
EB
1908 if (iscsilun->dpofua) {
1909 bs->supported_write_flags = BDRV_REQ_FUA;
1910 }
7191f208 1911
c1d4096b
FZ
1912 /* Check the write protect flag of the LUN if we want to write */
1913 if (iscsilun->type == TYPE_DISK && (flags & BDRV_O_RDWR) &&
43ae8fb1 1914 iscsilun->write_protected) {
8f3bf50d
KW
1915 ret = bdrv_apply_auto_read_only(bs, "LUN is write protected", errp);
1916 if (ret < 0) {
1917 goto out;
1918 }
1919 flags &= ~BDRV_O_RDWR;
c1d4096b
FZ
1920 }
1921
f2917853
PB
1922 iscsi_readcapacity_sync(iscsilun, &local_err);
1923 if (local_err != NULL) {
1924 error_propagate(errp, local_err);
cd82b6fb 1925 ret = -EINVAL;
cb1b83e7 1926 goto out;
e829b0bb 1927 }
0777b5dd 1928 bs->total_sectors = sector_lun2qemu(iscsilun->num_blocks, iscsilun);
e829b0bb 1929
f47c3f5a
KW
1930 /* We don't have any emulation for devices other than disks and CD-ROMs, so
1931 * this must be sg ioctl compatible. We force it to be sg, otherwise qemu
1932 * will try to read from the device to guess the image format.
622695a4 1933 */
f47c3f5a 1934 if (iscsilun->type != TYPE_DISK && iscsilun->type != TYPE_ROM) {
54115412 1935 bs->sg = true;
622695a4
RS
1936 }
1937
24d3bd67
PL
1938 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1939 SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES,
1940 (void **) &inq_vpd, errp);
1941 if (task == NULL) {
1942 ret = -EINVAL;
1943 goto out;
f18a7cbb 1944 }
24d3bd67
PL
1945 for (i = 0; i < inq_vpd->num_pages; i++) {
1946 struct scsi_task *inq_task;
1947 struct scsi_inquiry_logical_block_provisioning *inq_lbp;
f18a7cbb 1948 struct scsi_inquiry_block_limits *inq_bl;
cc9743c2 1949 struct scsi_inquiry_device_identification *inq_di;
24d3bd67
PL
1950 switch (inq_vpd->pages[i]) {
1951 case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING:
1952 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1953 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING,
1954 (void **) &inq_lbp, errp);
1955 if (inq_task == NULL) {
1956 ret = -EINVAL;
1957 goto out;
1958 }
1959 memcpy(&iscsilun->lbp, inq_lbp,
1960 sizeof(struct scsi_inquiry_logical_block_provisioning));
1961 scsi_free_scsi_task(inq_task);
1962 break;
1963 case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS:
1964 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1965 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS,
1966 (void **) &inq_bl, errp);
1967 if (inq_task == NULL) {
1968 ret = -EINVAL;
1969 goto out;
1970 }
1971 memcpy(&iscsilun->bl, inq_bl,
1972 sizeof(struct scsi_inquiry_block_limits));
1973 scsi_free_scsi_task(inq_task);
1974 break;
cc9743c2
FZ
1975 case SCSI_INQUIRY_PAGECODE_DEVICE_IDENTIFICATION:
1976 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1977 SCSI_INQUIRY_PAGECODE_DEVICE_IDENTIFICATION,
1978 (void **) &inq_di, errp);
1979 if (inq_task == NULL) {
1980 ret = -EINVAL;
1981 goto out;
1982 }
1983 iscsi_save_designator(iscsilun, inq_di);
1984 scsi_free_scsi_task(inq_task);
1985 break;
24d3bd67
PL
1986 default:
1987 break;
f18a7cbb 1988 }
f18a7cbb 1989 }
24d3bd67
PL
1990 scsi_free_scsi_task(task);
1991 task = NULL;
f18a7cbb 1992
d045c466 1993 qemu_mutex_init(&iscsilun->mutex);
80cf6257 1994 iscsi_attach_aio_context(bs, iscsilun->aio_context);
5b5d34ec 1995
b03c3805
PL
1996 /* Guess the internal cluster (page) size of the iscsi target by the means
1997 * of opt_unmap_gran. Transfer the unmap granularity only if it has a
1998 * reasonable size */
3d2acaa3 1999 if (iscsilun->bl.opt_unmap_gran * iscsilun->block_size >= 4 * 1024 &&
b03c3805 2000 iscsilun->bl.opt_unmap_gran * iscsilun->block_size <= 16 * 1024 * 1024) {
ba059e7b
EB
2001 iscsilun->cluster_size = iscsilun->bl.opt_unmap_gran *
2002 iscsilun->block_size;
9eac3622 2003 if (iscsilun->lbprz) {
e1123a3b 2004 ret = iscsi_allocmap_init(iscsilun, bs->open_flags);
b03c3805 2005 }
b03c3805
PL
2006 }
2007
e24d813b
EB
2008 if (iscsilun->lbprz && iscsilun->lbp.lbpws) {
2009 bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP;
2010 }
2011
b93c94f7 2012out:
60beb341 2013 qemu_opts_del(opts);
f7047c2d 2014 g_free(initiator_name);
e829b0bb
PL
2015 if (task != NULL) {
2016 scsi_free_scsi_task(task);
2017 }
b93c94f7
PB
2018
2019 if (ret) {
2020 if (iscsi != NULL) {
20474e9a
PL
2021 if (iscsi_is_logged_in(iscsi)) {
2022 iscsi_logout_sync(iscsi);
2023 }
b93c94f7
PB
2024 iscsi_destroy_context(iscsi);
2025 }
2026 memset(iscsilun, 0, sizeof(IscsiLun));
c589b249 2027 }
deadbb8e 2028
c589b249
RS
2029 return ret;
2030}
2031
2032static void iscsi_close(BlockDriverState *bs)
2033{
2034 IscsiLun *iscsilun = bs->opaque;
2035 struct iscsi_context *iscsi = iscsilun->iscsi;
2036
80cf6257 2037 iscsi_detach_aio_context(bs);
20474e9a
PL
2038 if (iscsi_is_logged_in(iscsi)) {
2039 iscsi_logout_sync(iscsi);
2040 }
c589b249 2041 iscsi_destroy_context(iscsi);
cc9743c2
FZ
2042 if (iscsilun->dd) {
2043 g_free(iscsilun->dd->designator);
2044 g_free(iscsilun->dd);
2045 }
d4cd9615 2046 g_free(iscsilun->zeroblock);
e1123a3b 2047 iscsi_allocmap_free(iscsilun);
d045c466 2048 qemu_mutex_destroy(&iscsilun->mutex);
c589b249
RS
2049 memset(iscsilun, 0, sizeof(IscsiLun));
2050}
2051
52f6fa14
PL
2052static void iscsi_refresh_limits(BlockDriverState *bs, Error **errp)
2053{
d34682cd
KW
2054 /* We don't actually refresh here, but just return data queried in
2055 * iscsi_open(): iscsi targets don't change their limits. */
52f6fa14
PL
2056
2057 IscsiLun *iscsilun = bs->opaque;
5def6b80 2058 uint64_t max_xfer_len = iscsilun->use_16_for_rw ? 0xffffffff : 0xffff;
95eaa785 2059 unsigned int block_size = MAX(BDRV_SECTOR_SIZE, iscsilun->block_size);
52f6fa14 2060
95eaa785
EB
2061 assert(iscsilun->block_size >= BDRV_SECTOR_SIZE || bs->sg);
2062
2063 bs->bl.request_alignment = block_size;
c8b3b998 2064
52f6fa14
PL
2065 if (iscsilun->bl.max_xfer_len) {
2066 max_xfer_len = MIN(max_xfer_len, iscsilun->bl.max_xfer_len);
2067 }
2068
95eaa785 2069 if (max_xfer_len * block_size < INT_MAX) {
5def6b80
EB
2070 bs->bl.max_transfer = max_xfer_len * iscsilun->block_size;
2071 }
52f6fa14 2072
c97ca29d 2073 if (iscsilun->lbp.lbpu) {
95eaa785 2074 if (iscsilun->bl.max_unmap < 0xffffffff / block_size) {
b9f7855a
EB
2075 bs->bl.max_pdiscard =
2076 iscsilun->bl.max_unmap * iscsilun->block_size;
d34682cd 2077 }
b9f7855a
EB
2078 bs->bl.pdiscard_alignment =
2079 iscsilun->bl.opt_unmap_gran * iscsilun->block_size;
8b184744 2080 } else {
b9f7855a 2081 bs->bl.pdiscard_alignment = iscsilun->block_size;
c97ca29d 2082 }
d34682cd 2083
95eaa785 2084 if (iscsilun->bl.max_ws_len < 0xffffffff / block_size) {
cf081fca
EB
2085 bs->bl.max_pwrite_zeroes =
2086 iscsilun->bl.max_ws_len * iscsilun->block_size;
c97ca29d
PB
2087 }
2088 if (iscsilun->lbp.lbpws) {
cf081fca
EB
2089 bs->bl.pwrite_zeroes_alignment =
2090 iscsilun->bl.opt_unmap_gran * iscsilun->block_size;
8b184744 2091 } else {
cf081fca 2092 bs->bl.pwrite_zeroes_alignment = iscsilun->block_size;
d34682cd 2093 }
5def6b80 2094 if (iscsilun->bl.opt_xfer_len &&
95eaa785 2095 iscsilun->bl.opt_xfer_len < INT_MAX / block_size) {
5def6b80
EB
2096 bs->bl.opt_transfer = pow2floor(iscsilun->bl.opt_xfer_len *
2097 iscsilun->block_size);
2098 }
e9f526ab 2099}
d34682cd 2100
43ae8fb1
FZ
2101/* Note that this will not re-establish a connection with an iSCSI target - it
2102 * is effectively a NOP. */
dc6afb99
JC
2103static int iscsi_reopen_prepare(BDRVReopenState *state,
2104 BlockReopenQueue *queue, Error **errp)
2105{
43ae8fb1
FZ
2106 IscsiLun *iscsilun = state->bs->opaque;
2107
2108 if (state->flags & BDRV_O_RDWR && iscsilun->write_protected) {
2109 error_setg(errp, "Cannot open a write protected LUN as read-write");
2110 return -EACCES;
2111 }
d34682cd
KW
2112 return 0;
2113}
2114
e1123a3b
PL
2115static void iscsi_reopen_commit(BDRVReopenState *reopen_state)
2116{
2117 IscsiLun *iscsilun = reopen_state->bs->opaque;
2118
2119 /* the cache.direct status might have changed */
2120 if (iscsilun->allocmap != NULL) {
2121 iscsi_allocmap_init(iscsilun, reopen_state->flags);
2122 }
2123}
2124
061ca8a3
KW
2125static int coroutine_fn iscsi_co_truncate(BlockDriverState *bs, int64_t offset,
2126 PreallocMode prealloc, Error **errp)
cb1b83e7
PL
2127{
2128 IscsiLun *iscsilun = bs->opaque;
f2917853 2129 Error *local_err = NULL;
cb1b83e7 2130
8243ccb7
HR
2131 if (prealloc != PREALLOC_MODE_OFF) {
2132 error_setg(errp, "Unsupported preallocation mode '%s'",
977c736f 2133 PreallocMode_str(prealloc));
8243ccb7
HR
2134 return -ENOTSUP;
2135 }
2136
cb1b83e7 2137 if (iscsilun->type != TYPE_DISK) {
f59adb32 2138 error_setg(errp, "Cannot resize non-disk iSCSI devices");
cb1b83e7
PL
2139 return -ENOTSUP;
2140 }
2141
f2917853
PB
2142 iscsi_readcapacity_sync(iscsilun, &local_err);
2143 if (local_err != NULL) {
4bff28b8 2144 error_propagate(errp, local_err);
f2917853 2145 return -EIO;
cb1b83e7
PL
2146 }
2147
2148 if (offset > iscsi_getlength(bs)) {
f59adb32 2149 error_setg(errp, "Cannot grow iSCSI devices");
cb1b83e7
PL
2150 return -EINVAL;
2151 }
2152
e1123a3b
PL
2153 if (iscsilun->allocmap != NULL) {
2154 iscsi_allocmap_init(iscsilun, bs->open_flags);
b03c3805
PL
2155 }
2156
cb1b83e7
PL
2157 return 0;
2158}
2159
efc75e2a
SH
2160static int coroutine_fn iscsi_co_create_opts(const char *filename, QemuOpts *opts,
2161 Error **errp)
de8864e5
PL
2162{
2163 int ret = 0;
2164 int64_t total_size = 0;
13c91cb7 2165 BlockDriverState *bs;
de8864e5 2166 IscsiLun *iscsilun = NULL;
60beb341 2167 QDict *bs_options;
2ec9a782 2168 Error *local_err = NULL;
de8864e5 2169
e4e9986b 2170 bs = bdrv_new();
de8864e5
PL
2171
2172 /* Read out options */
c2eb918e
HT
2173 total_size = DIV_ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2174 BDRV_SECTOR_SIZE);
5839e53b 2175 bs->opaque = g_new0(struct IscsiLun, 1);
13c91cb7 2176 iscsilun = bs->opaque;
de8864e5 2177
60beb341 2178 bs_options = qdict_new();
2ec9a782
FZ
2179 iscsi_parse_filename(filename, bs_options, &local_err);
2180 if (local_err) {
2181 error_propagate(errp, local_err);
2182 ret = -EINVAL;
2183 } else {
2184 ret = iscsi_open(bs, bs_options, 0, NULL);
2185 }
cb3e7f08 2186 qobject_unref(bs_options);
60beb341 2187
de8864e5
PL
2188 if (ret != 0) {
2189 goto out;
2190 }
80cf6257 2191 iscsi_detach_aio_context(bs);
de8864e5
PL
2192 if (iscsilun->type != TYPE_DISK) {
2193 ret = -ENODEV;
2194 goto out;
2195 }
13c91cb7 2196 if (bs->total_sectors < total_size) {
de8864e5 2197 ret = -ENOSPC;
d3bda7bc 2198 goto out;
de8864e5
PL
2199 }
2200
2201 ret = 0;
2202out:
2203 if (iscsilun->iscsi != NULL) {
2204 iscsi_destroy_context(iscsilun->iscsi);
2205 }
13c91cb7
FZ
2206 g_free(bs->opaque);
2207 bs->opaque = NULL;
4f6fd349 2208 bdrv_unref(bs);
de8864e5
PL
2209 return ret;
2210}
2211
186d4f2b
PL
2212static int iscsi_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2213{
2214 IscsiLun *iscsilun = bs->opaque;
0a386e48 2215 bdi->unallocated_blocks_are_zero = iscsilun->lbprz;
ba059e7b 2216 bdi->cluster_size = iscsilun->cluster_size;
186d4f2b
PL
2217 return 0;
2218}
2219
2b148f39
PB
2220static void coroutine_fn iscsi_co_invalidate_cache(BlockDriverState *bs,
2221 Error **errp)
e1123a3b
PL
2222{
2223 IscsiLun *iscsilun = bs->opaque;
2224 iscsi_allocmap_invalidate(iscsilun);
2225}
2226
604dfaaa
FZ
2227static int coroutine_fn iscsi_co_copy_range_from(BlockDriverState *bs,
2228 BdrvChild *src,
2229 uint64_t src_offset,
2230 BdrvChild *dst,
2231 uint64_t dst_offset,
2232 uint64_t bytes,
67b51fb9
VSO
2233 BdrvRequestFlags read_flags,
2234 BdrvRequestFlags write_flags)
604dfaaa 2235{
67b51fb9
VSO
2236 return bdrv_co_copy_range_to(src, src_offset, dst, dst_offset, bytes,
2237 read_flags, write_flags);
604dfaaa
FZ
2238}
2239
2240static struct scsi_task *iscsi_xcopy_task(int param_len)
2241{
2242 struct scsi_task *task;
2243
2244 task = g_new0(struct scsi_task, 1);
2245
2246 task->cdb[0] = EXTENDED_COPY;
2247 task->cdb[10] = (param_len >> 24) & 0xFF;
2248 task->cdb[11] = (param_len >> 16) & 0xFF;
2249 task->cdb[12] = (param_len >> 8) & 0xFF;
2250 task->cdb[13] = param_len & 0xFF;
2251 task->cdb_size = 16;
2252 task->xfer_dir = SCSI_XFER_WRITE;
2253 task->expxferlen = param_len;
2254
2255 return task;
2256}
2257
2258static void iscsi_populate_target_desc(unsigned char *desc, IscsiLun *lun)
2259{
2260 struct scsi_inquiry_device_designator *dd = lun->dd;
2261
2262 memset(desc, 0, 32);
2263 desc[0] = 0xE4; /* IDENT_DESCR_TGT_DESCR */
2264 desc[4] = dd->code_set;
2265 desc[5] = (dd->designator_type & 0xF)
2266 | ((dd->association & 3) << 4);
2267 desc[7] = dd->designator_length;
1439b9c1 2268 memcpy(desc + 8, dd->designator, MIN(dd->designator_length, 20));
604dfaaa
FZ
2269
2270 desc[28] = 0;
2271 desc[29] = (lun->block_size >> 16) & 0xFF;
2272 desc[30] = (lun->block_size >> 8) & 0xFF;
2273 desc[31] = lun->block_size & 0xFF;
2274}
2275
2276static void iscsi_xcopy_desc_hdr(uint8_t *hdr, int dc, int cat, int src_index,
2277 int dst_index)
2278{
2279 hdr[0] = 0x02; /* BLK_TO_BLK_SEG_DESCR */
2280 hdr[1] = ((dc << 1) | cat) & 0xFF;
2281 hdr[2] = (XCOPY_BLK2BLK_SEG_DESC_SIZE >> 8) & 0xFF;
2282 /* don't account for the first 4 bytes in descriptor header*/
2283 hdr[3] = (XCOPY_BLK2BLK_SEG_DESC_SIZE - 4 /* SEG_DESC_SRC_INDEX_OFFSET */) & 0xFF;
2284 hdr[4] = (src_index >> 8) & 0xFF;
2285 hdr[5] = src_index & 0xFF;
2286 hdr[6] = (dst_index >> 8) & 0xFF;
2287 hdr[7] = dst_index & 0xFF;
2288}
2289
2290static void iscsi_xcopy_populate_desc(uint8_t *desc, int dc, int cat,
2291 int src_index, int dst_index, int num_blks,
2292 uint64_t src_lba, uint64_t dst_lba)
2293{
2294 iscsi_xcopy_desc_hdr(desc, dc, cat, src_index, dst_index);
2295
2296 /* The caller should verify the request size */
2297 assert(num_blks < 65536);
2298 desc[10] = (num_blks >> 8) & 0xFF;
2299 desc[11] = num_blks & 0xFF;
2300 desc[12] = (src_lba >> 56) & 0xFF;
2301 desc[13] = (src_lba >> 48) & 0xFF;
2302 desc[14] = (src_lba >> 40) & 0xFF;
2303 desc[15] = (src_lba >> 32) & 0xFF;
2304 desc[16] = (src_lba >> 24) & 0xFF;
2305 desc[17] = (src_lba >> 16) & 0xFF;
2306 desc[18] = (src_lba >> 8) & 0xFF;
2307 desc[19] = src_lba & 0xFF;
2308 desc[20] = (dst_lba >> 56) & 0xFF;
2309 desc[21] = (dst_lba >> 48) & 0xFF;
2310 desc[22] = (dst_lba >> 40) & 0xFF;
2311 desc[23] = (dst_lba >> 32) & 0xFF;
2312 desc[24] = (dst_lba >> 24) & 0xFF;
2313 desc[25] = (dst_lba >> 16) & 0xFF;
2314 desc[26] = (dst_lba >> 8) & 0xFF;
2315 desc[27] = dst_lba & 0xFF;
2316}
2317
2318static void iscsi_xcopy_populate_header(unsigned char *buf, int list_id, int str,
2319 int list_id_usage, int prio,
2320 int tgt_desc_len,
2321 int seg_desc_len, int inline_data_len)
2322{
2323 buf[0] = list_id;
2324 buf[1] = ((str & 1) << 5) | ((list_id_usage & 3) << 3) | (prio & 7);
2325 buf[2] = (tgt_desc_len >> 8) & 0xFF;
2326 buf[3] = tgt_desc_len & 0xFF;
2327 buf[8] = (seg_desc_len >> 24) & 0xFF;
2328 buf[9] = (seg_desc_len >> 16) & 0xFF;
2329 buf[10] = (seg_desc_len >> 8) & 0xFF;
2330 buf[11] = seg_desc_len & 0xFF;
2331 buf[12] = (inline_data_len >> 24) & 0xFF;
2332 buf[13] = (inline_data_len >> 16) & 0xFF;
2333 buf[14] = (inline_data_len >> 8) & 0xFF;
2334 buf[15] = inline_data_len & 0xFF;
2335}
2336
2337static void iscsi_xcopy_data(struct iscsi_data *data,
2338 IscsiLun *src, int64_t src_lba,
2339 IscsiLun *dst, int64_t dst_lba,
2340 uint16_t num_blocks)
2341{
2342 uint8_t *buf;
2343 const int src_offset = XCOPY_DESC_OFFSET;
2344 const int dst_offset = XCOPY_DESC_OFFSET + IDENT_DESCR_TGT_DESCR_SIZE;
2345 const int seg_offset = dst_offset + IDENT_DESCR_TGT_DESCR_SIZE;
2346
2347 data->size = XCOPY_DESC_OFFSET +
2348 IDENT_DESCR_TGT_DESCR_SIZE * 2 +
2349 XCOPY_BLK2BLK_SEG_DESC_SIZE;
2350 data->data = g_malloc0(data->size);
2351 buf = data->data;
2352
2353 /* Initialise the parameter list header */
2354 iscsi_xcopy_populate_header(buf, 1, 0, 2 /* LIST_ID_USAGE_DISCARD */,
2355 0, 2 * IDENT_DESCR_TGT_DESCR_SIZE,
2356 XCOPY_BLK2BLK_SEG_DESC_SIZE,
2357 0);
2358
2359 /* Initialise CSCD list with one src + one dst descriptor */
2360 iscsi_populate_target_desc(&buf[src_offset], src);
2361 iscsi_populate_target_desc(&buf[dst_offset], dst);
2362
2363 /* Initialise one segment descriptor */
2364 iscsi_xcopy_populate_desc(&buf[seg_offset], 0, 0, 0, 1, num_blocks,
2365 src_lba, dst_lba);
2366}
2367
2368static int coroutine_fn iscsi_co_copy_range_to(BlockDriverState *bs,
2369 BdrvChild *src,
2370 uint64_t src_offset,
2371 BdrvChild *dst,
2372 uint64_t dst_offset,
2373 uint64_t bytes,
67b51fb9
VSO
2374 BdrvRequestFlags read_flags,
2375 BdrvRequestFlags write_flags)
604dfaaa
FZ
2376{
2377 IscsiLun *dst_lun = dst->bs->opaque;
2378 IscsiLun *src_lun;
2379 struct IscsiTask iscsi_task;
2380 struct iscsi_data data;
2381 int r = 0;
2382 int block_size;
2383
2384 if (src->bs->drv->bdrv_co_copy_range_to != iscsi_co_copy_range_to) {
2385 return -ENOTSUP;
2386 }
2387 src_lun = src->bs->opaque;
2388
2389 if (!src_lun->dd || !dst_lun->dd) {
2390 return -ENOTSUP;
2391 }
2392 if (!is_byte_request_lun_aligned(dst_offset, bytes, dst_lun)) {
2393 return -ENOTSUP;
2394 }
2395 if (!is_byte_request_lun_aligned(src_offset, bytes, src_lun)) {
2396 return -ENOTSUP;
2397 }
2398 if (dst_lun->block_size != src_lun->block_size ||
2399 !dst_lun->block_size) {
2400 return -ENOTSUP;
2401 }
2402
2403 block_size = dst_lun->block_size;
2404 if (bytes / block_size > 65535) {
2405 return -ENOTSUP;
2406 }
2407
2408 iscsi_xcopy_data(&data,
2409 src_lun, src_offset / block_size,
2410 dst_lun, dst_offset / block_size,
2411 bytes / block_size);
2412
2413 iscsi_co_init_iscsitask(dst_lun, &iscsi_task);
2414
2415 qemu_mutex_lock(&dst_lun->mutex);
2416 iscsi_task.task = iscsi_xcopy_task(data.size);
2417retry:
2418 if (iscsi_scsi_command_async(dst_lun->iscsi, dst_lun->lun,
2419 iscsi_task.task, iscsi_co_generic_cb,
2420 &data,
2421 &iscsi_task) != 0) {
2422 r = -EIO;
2423 goto out_unlock;
2424 }
2425
2426 iscsi_co_wait_for_task(&iscsi_task, dst_lun);
2427
2428 if (iscsi_task.do_retry) {
2429 iscsi_task.complete = 0;
2430 goto retry;
2431 }
2432
2433 if (iscsi_task.status != SCSI_STATUS_GOOD) {
2434 r = iscsi_task.err_code;
2435 goto out_unlock;
2436 }
2437
2438out_unlock:
ecc983a5
FZ
2439
2440 trace_iscsi_xcopy(src_lun, src_offset, dst_lun, dst_offset, bytes, r);
604dfaaa
FZ
2441 g_free(iscsi_task.task);
2442 qemu_mutex_unlock(&dst_lun->mutex);
2443 g_free(iscsi_task.err_str);
2444 return r;
2445}
2446
a59479e3
CL
2447static QemuOptsList iscsi_create_opts = {
2448 .name = "iscsi-create-opts",
2449 .head = QTAILQ_HEAD_INITIALIZER(iscsi_create_opts.head),
2450 .desc = {
2451 {
2452 .name = BLOCK_OPT_SIZE,
2453 .type = QEMU_OPT_SIZE,
2454 .help = "Virtual disk size"
2455 },
2456 { /* end of list */ }
2457 }
de8864e5
PL
2458};
2459
2654267c
HR
2460static const char *const iscsi_strong_runtime_opts[] = {
2461 "transport",
2462 "portal",
2463 "target",
2464 "user",
2465 "password",
2466 "password-secret",
2467 "lun",
2468 "initiator-name",
2469 "header-digest",
2470
2471 NULL
2472};
2473
c589b249
RS
2474static BlockDriver bdrv_iscsi = {
2475 .format_name = "iscsi",
2476 .protocol_name = "iscsi",
2477
d5895fcb
KW
2478 .instance_size = sizeof(IscsiLun),
2479 .bdrv_parse_filename = iscsi_parse_filename,
2480 .bdrv_file_open = iscsi_open,
2481 .bdrv_close = iscsi_close,
efc75e2a 2482 .bdrv_co_create_opts = iscsi_co_create_opts,
d5895fcb
KW
2483 .create_opts = &iscsi_create_opts,
2484 .bdrv_reopen_prepare = iscsi_reopen_prepare,
2485 .bdrv_reopen_commit = iscsi_reopen_commit,
2b148f39 2486 .bdrv_co_invalidate_cache = iscsi_co_invalidate_cache,
c589b249
RS
2487
2488 .bdrv_getlength = iscsi_getlength,
186d4f2b 2489 .bdrv_get_info = iscsi_get_info,
061ca8a3 2490 .bdrv_co_truncate = iscsi_co_truncate,
d34682cd 2491 .bdrv_refresh_limits = iscsi_refresh_limits,
c589b249 2492
92809c36 2493 .bdrv_co_block_status = iscsi_co_block_status,
97c7e85c 2494 .bdrv_co_pdiscard = iscsi_co_pdiscard,
604dfaaa
FZ
2495 .bdrv_co_copy_range_from = iscsi_co_copy_range_from,
2496 .bdrv_co_copy_range_to = iscsi_co_copy_range_to,
94d047a3 2497 .bdrv_co_pwrite_zeroes = iscsi_co_pwrite_zeroes,
063c3378 2498 .bdrv_co_readv = iscsi_co_readv,
e18a58b4 2499 .bdrv_co_writev = iscsi_co_writev,
063c3378 2500 .bdrv_co_flush_to_disk = iscsi_co_flush,
fa6acb0c 2501
98392453 2502#ifdef __linux__
98392453
RS
2503 .bdrv_aio_ioctl = iscsi_aio_ioctl,
2504#endif
80cf6257
SH
2505
2506 .bdrv_detach_aio_context = iscsi_detach_aio_context,
2507 .bdrv_attach_aio_context = iscsi_attach_aio_context,
2654267c
HR
2508
2509 .strong_runtime_opts = iscsi_strong_runtime_opts,
c589b249
RS
2510};
2511
e0ae4987
RS
2512#if LIBISCSI_API_VERSION >= (20160603)
2513static BlockDriver bdrv_iser = {
2514 .format_name = "iser",
2515 .protocol_name = "iser",
2516
d5895fcb
KW
2517 .instance_size = sizeof(IscsiLun),
2518 .bdrv_parse_filename = iscsi_parse_filename,
2519 .bdrv_file_open = iscsi_open,
2520 .bdrv_close = iscsi_close,
efc75e2a 2521 .bdrv_co_create_opts = iscsi_co_create_opts,
d5895fcb
KW
2522 .create_opts = &iscsi_create_opts,
2523 .bdrv_reopen_prepare = iscsi_reopen_prepare,
2524 .bdrv_reopen_commit = iscsi_reopen_commit,
b16a7cfa 2525 .bdrv_co_invalidate_cache = iscsi_co_invalidate_cache,
e0ae4987
RS
2526
2527 .bdrv_getlength = iscsi_getlength,
2528 .bdrv_get_info = iscsi_get_info,
061ca8a3 2529 .bdrv_co_truncate = iscsi_co_truncate,
e0ae4987
RS
2530 .bdrv_refresh_limits = iscsi_refresh_limits,
2531
92809c36 2532 .bdrv_co_block_status = iscsi_co_block_status,
e0ae4987 2533 .bdrv_co_pdiscard = iscsi_co_pdiscard,
604dfaaa
FZ
2534 .bdrv_co_copy_range_from = iscsi_co_copy_range_from,
2535 .bdrv_co_copy_range_to = iscsi_co_copy_range_to,
e0ae4987
RS
2536 .bdrv_co_pwrite_zeroes = iscsi_co_pwrite_zeroes,
2537 .bdrv_co_readv = iscsi_co_readv,
e18a58b4 2538 .bdrv_co_writev = iscsi_co_writev,
e0ae4987
RS
2539 .bdrv_co_flush_to_disk = iscsi_co_flush,
2540
2541#ifdef __linux__
2542 .bdrv_aio_ioctl = iscsi_aio_ioctl,
2543#endif
2544
2545 .bdrv_detach_aio_context = iscsi_detach_aio_context,
2546 .bdrv_attach_aio_context = iscsi_attach_aio_context,
2654267c
HR
2547
2548 .strong_runtime_opts = iscsi_strong_runtime_opts,
e0ae4987
RS
2549};
2550#endif
2551
c589b249
RS
2552static void iscsi_block_init(void)
2553{
2554 bdrv_register(&bdrv_iscsi);
e0ae4987
RS
2555#if LIBISCSI_API_VERSION >= (20160603)
2556 bdrv_register(&bdrv_iser);
2557#endif
c589b249
RS
2558}
2559
2560block_init(iscsi_block_init);