]> git.proxmox.com Git - mirror_qemu.git/blame - hw/block/virtio-blk.c
virtio-blk: convert to virtqueue_map
[mirror_qemu.git] / hw / block / virtio-blk.c
CommitLineData
6e02c38d
AL
1/*
2 * Virtio Block Device
3 *
4 * Copyright IBM, Corp. 2007
5 *
6 * Authors:
7 * Anthony Liguori <aliguori@us.ibm.com>
8 *
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
11 *
12 */
13
5a61cb60 14#include "qemu-common.h"
827805a2 15#include "qemu/iov.h"
1de7afc9 16#include "qemu/error-report.h"
6d519a5f 17#include "trace.h"
0d09e41a 18#include "hw/block/block.h"
4be74634 19#include "sysemu/block-backend.h"
9c17d615 20#include "sysemu/blockdev.h"
0d09e41a 21#include "hw/virtio/virtio-blk.h"
52b53c04
FZ
22#include "dataplane/virtio-blk.h"
23#include "migration/migration.h"
0d09e41a 24#include "block/scsi.h"
1063b8b1
CH
25#ifdef __linux__
26# include <scsi/sg.h>
27#endif
0d09e41a 28#include "hw/virtio/virtio-bus.h"
783d1897 29#include "hw/virtio/virtio-access.h"
6e02c38d 30
f897bf75 31VirtIOBlockReq *virtio_blk_alloc_request(VirtIOBlock *s)
671ec3f0 32{
c84b3192 33 VirtIOBlockReq *req = g_new(VirtIOBlockReq, 1);
671ec3f0 34 req->dev = s;
869d66af 35 req->qiov.size = 0;
2a6cdd6d 36 req->in_len = 0;
869d66af 37 req->next = NULL;
95f7142a 38 req->mr_next = NULL;
671ec3f0
FZ
39 return req;
40}
41
f897bf75 42void virtio_blk_free_request(VirtIOBlockReq *req)
671ec3f0
FZ
43{
44 if (req) {
c84b3192 45 g_free(req);
671ec3f0
FZ
46 }
47}
48
bf4bd461
FZ
49static void virtio_blk_complete_request(VirtIOBlockReq *req,
50 unsigned char status)
869a5c6d
AL
51{
52 VirtIOBlock *s = req->dev;
1cc91b7d 53 VirtIODevice *vdev = VIRTIO_DEVICE(s);
869a5c6d 54
6d519a5f
SH
55 trace_virtio_blk_req_complete(req, status);
56
92e3c2a3 57 stb_p(&req->in->status, status);
2a6cdd6d 58 virtqueue_push(s->vq, &req->elem, req->in_len);
1cc91b7d 59 virtio_notify(vdev, s->vq);
869a5c6d
AL
60}
61
bf4bd461
FZ
62static void virtio_blk_req_complete(VirtIOBlockReq *req, unsigned char status)
63{
64 req->dev->complete_request(req, status);
65}
66
f35d68f0 67static int virtio_blk_handle_rw_error(VirtIOBlockReq *req, int error,
1ceee0d5 68 bool is_read)
869a5c6d 69{
4be74634
MA
70 BlockErrorAction action = blk_get_error_action(req->dev->blk,
71 is_read, error);
869a5c6d
AL
72 VirtIOBlock *s = req->dev;
73
a589569f 74 if (action == BLOCK_ERROR_ACTION_STOP) {
869a5c6d
AL
75 req->next = s->rq;
76 s->rq = req;
a589569f 77 } else if (action == BLOCK_ERROR_ACTION_REPORT) {
869a5c6d 78 virtio_blk_req_complete(req, VIRTIO_BLK_S_IOERR);
4be74634 79 block_acct_done(blk_get_stats(s->blk), &req->acct);
671ec3f0 80 virtio_blk_free_request(req);
869a5c6d
AL
81 }
82
4be74634 83 blk_error_action(s->blk, action, is_read, error);
a589569f 84 return action != BLOCK_ERROR_ACTION_IGNORE;
869a5c6d
AL
85}
86
6e02c38d
AL
87static void virtio_blk_rw_complete(void *opaque, int ret)
88{
95f7142a
PL
89 VirtIOBlockReq *next = opaque;
90
91 while (next) {
92 VirtIOBlockReq *req = next;
93 next = req->mr_next;
94 trace_virtio_blk_rw_complete(req, ret);
95
96 if (req->qiov.nalloc != -1) {
97 /* If nalloc is != 1 req->qiov is a local copy of the original
98 * external iovec. It was allocated in submit_merged_requests
99 * to be able to merge requests. */
100 qemu_iovec_destroy(&req->qiov);
101 }
6e02c38d 102
95f7142a
PL
103 if (ret) {
104 int p = virtio_ldl_p(VIRTIO_DEVICE(req->dev), &req->out.type);
105 bool is_read = !(p & VIRTIO_BLK_T_OUT);
2a6cdd6d
PB
106 /* Note that memory may be dirtied on read failure. If the
107 * virtio request is not completed here, as is the case for
108 * BLOCK_ERROR_ACTION_STOP, the memory may not be copied
109 * correctly during live migration. While this is ugly,
110 * it is acceptable because the device is free to write to
111 * the memory until the request is completed (which will
112 * happen on the other side of the migration).
113 */
95f7142a
PL
114 if (virtio_blk_handle_rw_error(req, -ret, is_read)) {
115 continue;
116 }
117 }
6d519a5f 118
95f7142a
PL
119 virtio_blk_req_complete(req, VIRTIO_BLK_S_OK);
120 block_acct_done(blk_get_stats(req->dev->blk), &req->acct);
121 virtio_blk_free_request(req);
6e02c38d 122 }
869a5c6d 123}
6e02c38d 124
aa659be3
CH
125static void virtio_blk_flush_complete(void *opaque, int ret)
126{
127 VirtIOBlockReq *req = opaque;
128
8c269b54
KW
129 if (ret) {
130 if (virtio_blk_handle_rw_error(req, -ret, 0)) {
131 return;
132 }
133 }
134
135 virtio_blk_req_complete(req, VIRTIO_BLK_S_OK);
4be74634 136 block_acct_done(blk_get_stats(req->dev->blk), &req->acct);
671ec3f0 137 virtio_blk_free_request(req);
6e02c38d
AL
138}
139
1dc936aa
FZ
140#ifdef __linux__
141
142typedef struct {
143 VirtIOBlockReq *req;
144 struct sg_io_hdr hdr;
145} VirtIOBlockIoctlReq;
146
147static void virtio_blk_ioctl_complete(void *opaque, int status)
148{
149 VirtIOBlockIoctlReq *ioctl_req = opaque;
150 VirtIOBlockReq *req = ioctl_req->req;
151 VirtIODevice *vdev = VIRTIO_DEVICE(req->dev);
152 struct virtio_scsi_inhdr *scsi;
153 struct sg_io_hdr *hdr;
154
155 scsi = (void *)req->elem.in_sg[req->elem.in_num - 2].iov_base;
156
157 if (status) {
158 status = VIRTIO_BLK_S_UNSUPP;
159 virtio_stl_p(vdev, &scsi->errors, 255);
160 goto out;
161 }
162
163 hdr = &ioctl_req->hdr;
164 /*
165 * From SCSI-Generic-HOWTO: "Some lower level drivers (e.g. ide-scsi)
166 * clear the masked_status field [hence status gets cleared too, see
167 * block/scsi_ioctl.c] even when a CHECK_CONDITION or COMMAND_TERMINATED
168 * status has occurred. However they do set DRIVER_SENSE in driver_status
169 * field. Also a (sb_len_wr > 0) indicates there is a sense buffer.
170 */
171 if (hdr->status == 0 && hdr->sb_len_wr > 0) {
172 hdr->status = CHECK_CONDITION;
173 }
174
175 virtio_stl_p(vdev, &scsi->errors,
176 hdr->status | (hdr->msg_status << 8) |
177 (hdr->host_status << 16) | (hdr->driver_status << 24));
178 virtio_stl_p(vdev, &scsi->residual, hdr->resid);
179 virtio_stl_p(vdev, &scsi->sense_len, hdr->sb_len_wr);
180 virtio_stl_p(vdev, &scsi->data_len, hdr->dxfer_len);
181
182out:
183 virtio_blk_req_complete(req, status);
184 virtio_blk_free_request(req);
185 g_free(ioctl_req);
186}
187
188#endif
189
6e02c38d
AL
190static VirtIOBlockReq *virtio_blk_get_request(VirtIOBlock *s)
191{
869a5c6d 192 VirtIOBlockReq *req = virtio_blk_alloc_request(s);
6e02c38d 193
f897bf75 194 if (!virtqueue_pop(s->vq, &req->elem)) {
671ec3f0
FZ
195 virtio_blk_free_request(req);
196 return NULL;
6e02c38d
AL
197 }
198
199 return req;
200}
201
75344fa4 202static int virtio_blk_handle_scsi_req(VirtIOBlockReq *req)
1063b8b1 203{
5a05cbee
FZ
204 int status = VIRTIO_BLK_S_OK;
205 struct virtio_scsi_inhdr *scsi = NULL;
75344fa4
FZ
206 VirtIODevice *vdev = VIRTIO_DEVICE(req->dev);
207 VirtQueueElement *elem = &req->elem;
208 VirtIOBlock *blk = req->dev;
783d1897 209
47ce9ef7 210#ifdef __linux__
1063b8b1 211 int i;
1dc936aa 212 VirtIOBlockIoctlReq *ioctl_req;
a209f461 213 BlockAIOCB *acb;
47ce9ef7 214#endif
1063b8b1
CH
215
216 /*
217 * We require at least one output segment each for the virtio_blk_outhdr
218 * and the SCSI command block.
219 *
220 * We also at least require the virtio_blk_inhdr, the virtio_scsi_inhdr
221 * and the sense buffer pointer in the input segments.
222 */
5a05cbee
FZ
223 if (elem->out_num < 2 || elem->in_num < 3) {
224 status = VIRTIO_BLK_S_IOERR;
225 goto fail;
1063b8b1
CH
226 }
227
228 /*
f34e73cd
PB
229 * The scsi inhdr is placed in the second-to-last input segment, just
230 * before the regular inhdr.
1063b8b1 231 */
5a05cbee 232 scsi = (void *)elem->in_sg[elem->in_num - 2].iov_base;
f34e73cd 233
2a30307f 234 if (!blk->conf.scsi) {
f34e73cd
PB
235 status = VIRTIO_BLK_S_UNSUPP;
236 goto fail;
1063b8b1
CH
237 }
238
239 /*
f34e73cd 240 * No support for bidirection commands yet.
1063b8b1 241 */
5a05cbee 242 if (elem->out_num > 2 && elem->in_num > 3) {
f34e73cd
PB
243 status = VIRTIO_BLK_S_UNSUPP;
244 goto fail;
245 }
1063b8b1 246
f34e73cd 247#ifdef __linux__
1dc936aa
FZ
248 ioctl_req = g_new0(VirtIOBlockIoctlReq, 1);
249 ioctl_req->req = req;
250 ioctl_req->hdr.interface_id = 'S';
251 ioctl_req->hdr.cmd_len = elem->out_sg[1].iov_len;
252 ioctl_req->hdr.cmdp = elem->out_sg[1].iov_base;
253 ioctl_req->hdr.dxfer_len = 0;
1063b8b1 254
5a05cbee 255 if (elem->out_num > 2) {
1063b8b1
CH
256 /*
257 * If there are more than the minimally required 2 output segments
258 * there is write payload starting from the third iovec.
259 */
1dc936aa
FZ
260 ioctl_req->hdr.dxfer_direction = SG_DXFER_TO_DEV;
261 ioctl_req->hdr.iovec_count = elem->out_num - 2;
1063b8b1 262
1dc936aa
FZ
263 for (i = 0; i < ioctl_req->hdr.iovec_count; i++) {
264 ioctl_req->hdr.dxfer_len += elem->out_sg[i + 2].iov_len;
265 }
1063b8b1 266
1dc936aa 267 ioctl_req->hdr.dxferp = elem->out_sg + 2;
1063b8b1 268
5a05cbee 269 } else if (elem->in_num > 3) {
1063b8b1
CH
270 /*
271 * If we have more than 3 input segments the guest wants to actually
272 * read data.
273 */
1dc936aa
FZ
274 ioctl_req->hdr.dxfer_direction = SG_DXFER_FROM_DEV;
275 ioctl_req->hdr.iovec_count = elem->in_num - 3;
276 for (i = 0; i < ioctl_req->hdr.iovec_count; i++) {
277 ioctl_req->hdr.dxfer_len += elem->in_sg[i].iov_len;
278 }
1063b8b1 279
1dc936aa 280 ioctl_req->hdr.dxferp = elem->in_sg;
1063b8b1
CH
281 } else {
282 /*
283 * Some SCSI commands don't actually transfer any data.
284 */
1dc936aa 285 ioctl_req->hdr.dxfer_direction = SG_DXFER_NONE;
1063b8b1
CH
286 }
287
1dc936aa
FZ
288 ioctl_req->hdr.sbp = elem->in_sg[elem->in_num - 3].iov_base;
289 ioctl_req->hdr.mx_sb_len = elem->in_sg[elem->in_num - 3].iov_len;
1063b8b1 290
a209f461
FZ
291 acb = blk_aio_ioctl(blk->blk, SG_IO, &ioctl_req->hdr,
292 virtio_blk_ioctl_complete, ioctl_req);
293 if (!acb) {
294 g_free(ioctl_req);
295 status = VIRTIO_BLK_S_UNSUPP;
296 goto fail;
297 }
1dc936aa 298 return -EINPROGRESS;
1063b8b1 299#else
f34e73cd
PB
300 abort();
301#endif
302
303fail:
304 /* Just put anything nonzero so that the ioctl fails in the guest. */
5a05cbee 305 if (scsi) {
783d1897 306 virtio_stl_p(vdev, &scsi->errors, 255);
5a05cbee
FZ
307 }
308 return status;
309}
310
311static void virtio_blk_handle_scsi(VirtIOBlockReq *req)
312{
313 int status;
314
75344fa4 315 status = virtio_blk_handle_scsi_req(req);
1dc936aa
FZ
316 if (status != -EINPROGRESS) {
317 virtio_blk_req_complete(req, status);
318 virtio_blk_free_request(req);
319 }
1063b8b1 320}
1063b8b1 321
95f7142a
PL
322static inline void submit_requests(BlockBackend *blk, MultiReqBuffer *mrb,
323 int start, int num_reqs, int niov)
869a5c6d 324{
95f7142a
PL
325 QEMUIOVector *qiov = &mrb->reqs[start]->qiov;
326 int64_t sector_num = mrb->reqs[start]->sector_num;
327 int nb_sectors = mrb->reqs[start]->qiov.size / BDRV_SECTOR_SIZE;
328 bool is_write = mrb->is_write;
329
330 if (num_reqs > 1) {
331 int i;
332 struct iovec *tmp_iov = qiov->iov;
333 int tmp_niov = qiov->niov;
334
335 /* mrb->reqs[start]->qiov was initialized from external so we can't
336 * modifiy it here. We need to initialize it locally and then add the
337 * external iovecs. */
338 qemu_iovec_init(qiov, niov);
339
340 for (i = 0; i < tmp_niov; i++) {
341 qemu_iovec_add(qiov, tmp_iov[i].iov_base, tmp_iov[i].iov_len);
342 }
343
344 for (i = start + 1; i < start + num_reqs; i++) {
345 qemu_iovec_concat(qiov, &mrb->reqs[i]->qiov, 0,
346 mrb->reqs[i]->qiov.size);
347 mrb->reqs[i - 1]->mr_next = mrb->reqs[i];
348 nb_sectors += mrb->reqs[i]->qiov.size / BDRV_SECTOR_SIZE;
349 }
350 assert(nb_sectors == qiov->size / BDRV_SECTOR_SIZE);
351
352 trace_virtio_blk_submit_multireq(mrb, start, num_reqs, sector_num,
353 nb_sectors, is_write);
354 block_acct_merge_done(blk_get_stats(blk),
355 is_write ? BLOCK_ACCT_WRITE : BLOCK_ACCT_READ,
356 num_reqs - 1);
357 }
91553dcc 358
95f7142a
PL
359 if (is_write) {
360 blk_aio_writev(blk, sector_num, qiov, nb_sectors,
361 virtio_blk_rw_complete, mrb->reqs[start]);
362 } else {
363 blk_aio_readv(blk, sector_num, qiov, nb_sectors,
364 virtio_blk_rw_complete, mrb->reqs[start]);
365 }
366}
367
368static int multireq_compare(const void *a, const void *b)
369{
370 const VirtIOBlockReq *req1 = *(VirtIOBlockReq **)a,
371 *req2 = *(VirtIOBlockReq **)b;
372
373 /*
374 * Note that we can't simply subtract sector_num1 from sector_num2
375 * here as that could overflow the return value.
376 */
377 if (req1->sector_num > req2->sector_num) {
378 return 1;
379 } else if (req1->sector_num < req2->sector_num) {
380 return -1;
381 } else {
382 return 0;
383 }
384}
385
386void virtio_blk_submit_multireq(BlockBackend *blk, MultiReqBuffer *mrb)
387{
388 int i = 0, start = 0, num_reqs = 0, niov = 0, nb_sectors = 0;
389 int max_xfer_len = 0;
390 int64_t sector_num = 0;
391
392 if (mrb->num_reqs == 1) {
393 submit_requests(blk, mrb, 0, 1, -1);
394 mrb->num_reqs = 0;
c20fd872
CH
395 return;
396 }
397
95f7142a 398 max_xfer_len = blk_get_max_transfer_length(mrb->reqs[0]->dev->blk);
75af1f34 399 max_xfer_len = MIN_NON_ZERO(max_xfer_len, BDRV_REQUEST_MAX_SECTORS);
95f7142a
PL
400
401 qsort(mrb->reqs, mrb->num_reqs, sizeof(*mrb->reqs),
402 &multireq_compare);
403
404 for (i = 0; i < mrb->num_reqs; i++) {
405 VirtIOBlockReq *req = mrb->reqs[i];
406 if (num_reqs > 0) {
407 bool merge = true;
408
409 /* merge would exceed maximum number of IOVs */
410 if (niov + req->qiov.niov > IOV_MAX) {
411 merge = false;
412 }
413
414 /* merge would exceed maximum transfer length of backend device */
415 if (req->qiov.size / BDRV_SECTOR_SIZE + nb_sectors > max_xfer_len) {
416 merge = false;
417 }
418
419 /* requests are not sequential */
420 if (sector_num + nb_sectors != req->sector_num) {
421 merge = false;
422 }
423
424 if (!merge) {
425 submit_requests(blk, mrb, start, num_reqs, niov);
426 num_reqs = 0;
91553dcc
KW
427 }
428 }
95f7142a
PL
429
430 if (num_reqs == 0) {
431 sector_num = req->sector_num;
432 nb_sectors = niov = 0;
433 start = i;
434 }
435
436 nb_sectors += req->qiov.size / BDRV_SECTOR_SIZE;
437 niov += req->qiov.niov;
438 num_reqs++;
91553dcc 439 }
c20fd872 440
95f7142a
PL
441 submit_requests(blk, mrb, start, num_reqs, niov);
442 mrb->num_reqs = 0;
91553dcc 443}
87b245db 444
c20fd872 445static void virtio_blk_handle_flush(VirtIOBlockReq *req, MultiReqBuffer *mrb)
aa659be3 446{
4be74634 447 block_acct_start(blk_get_stats(req->dev->blk), &req->acct, 0,
5366d0c8 448 BLOCK_ACCT_FLUSH);
a597e79c 449
618fbb84
CH
450 /*
451 * Make sure all outstanding writes are posted to the backing device.
452 */
95f7142a
PL
453 if (mrb->is_write && mrb->num_reqs > 0) {
454 virtio_blk_submit_multireq(req->dev->blk, mrb);
455 }
4be74634 456 blk_aio_flush(req->dev->blk, virtio_blk_flush_complete, req);
aa659be3
CH
457}
458
d0e14376
MA
459static bool virtio_blk_sect_range_ok(VirtIOBlock *dev,
460 uint64_t sector, size_t size)
461{
3c2daac0
MA
462 uint64_t nb_sectors = size >> BDRV_SECTOR_BITS;
463 uint64_t total_sectors;
464
75af1f34 465 if (nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
95f7142a
PL
466 return false;
467 }
d0e14376
MA
468 if (sector & dev->sector_mask) {
469 return false;
470 }
2a30307f 471 if (size % dev->conf.conf.logical_block_size) {
d0e14376
MA
472 return false;
473 }
4be74634 474 blk_get_geometry(dev->blk, &total_sectors);
3c2daac0
MA
475 if (sector > total_sectors || nb_sectors > total_sectors - sector) {
476 return false;
477 }
d0e14376
MA
478 return true;
479}
480
fee65db7 481void virtio_blk_handle_request(VirtIOBlockReq *req, MultiReqBuffer *mrb)
bc6694d4 482{
92e3c2a3 483 uint32_t type;
f897bf75
SH
484 struct iovec *in_iov = req->elem.in_sg;
485 struct iovec *iov = req->elem.out_sg;
486 unsigned in_num = req->elem.in_num;
487 unsigned out_num = req->elem.out_num;
92e3c2a3 488
f897bf75 489 if (req->elem.out_num < 1 || req->elem.in_num < 1) {
870cef1d 490 error_report("virtio-blk missing headers");
bc6694d4
KW
491 exit(1);
492 }
493
827805a2
FZ
494 if (unlikely(iov_to_buf(iov, out_num, 0, &req->out,
495 sizeof(req->out)) != sizeof(req->out))) {
496 error_report("virtio-blk request outhdr too short");
497 exit(1);
498 }
ee17e848 499
827805a2 500 iov_discard_front(&iov, &out_num, sizeof(req->out));
ee17e848 501
12048545 502 if (in_iov[in_num - 1].iov_len < sizeof(struct virtio_blk_inhdr)) {
ee17e848
FZ
503 error_report("virtio-blk request inhdr too short");
504 exit(1);
505 }
506
2a6cdd6d
PB
507 /* We always touch the last byte, so just see how big in_iov is. */
508 req->in_len = iov_size(in_iov, in_num);
ee17e848
FZ
509 req->in = (void *)in_iov[in_num - 1].iov_base
510 + in_iov[in_num - 1].iov_len
511 - sizeof(struct virtio_blk_inhdr);
512 iov_discard_back(in_iov, &in_num, sizeof(struct virtio_blk_inhdr));
bc6694d4 513
783d1897 514 type = virtio_ldl_p(VIRTIO_DEVICE(req->dev), &req->out.type);
92e3c2a3 515
95f7142a 516 /* VIRTIO_BLK_T_OUT defines the command direction. VIRTIO_BLK_T_BARRIER
631b22ea 517 * is an optional flag. Although a guest should not send this flag if
95f7142a
PL
518 * not negotiated we ignored it in the past. So keep ignoring it. */
519 switch (type & ~(VIRTIO_BLK_T_OUT | VIRTIO_BLK_T_BARRIER)) {
520 case VIRTIO_BLK_T_IN:
521 {
522 bool is_write = type & VIRTIO_BLK_T_OUT;
523 req->sector_num = virtio_ldq_p(VIRTIO_DEVICE(req->dev),
524 &req->out.sector);
525
526 if (is_write) {
527 qemu_iovec_init_external(&req->qiov, iov, out_num);
528 trace_virtio_blk_handle_write(req, req->sector_num,
529 req->qiov.size / BDRV_SECTOR_SIZE);
530 } else {
531 qemu_iovec_init_external(&req->qiov, in_iov, in_num);
532 trace_virtio_blk_handle_read(req, req->sector_num,
533 req->qiov.size / BDRV_SECTOR_SIZE);
534 }
535
536 if (!virtio_blk_sect_range_ok(req->dev, req->sector_num,
537 req->qiov.size)) {
538 virtio_blk_req_complete(req, VIRTIO_BLK_S_IOERR);
539 virtio_blk_free_request(req);
540 return;
541 }
542
543 block_acct_start(blk_get_stats(req->dev->blk),
544 &req->acct, req->qiov.size,
545 is_write ? BLOCK_ACCT_WRITE : BLOCK_ACCT_READ);
546
547 /* merge would exceed maximum number of requests or IO direction
548 * changes */
549 if (mrb->num_reqs > 0 && (mrb->num_reqs == VIRTIO_BLK_MAX_MERGE_REQS ||
c99495ac
PL
550 is_write != mrb->is_write ||
551 !req->dev->conf.request_merging)) {
95f7142a
PL
552 virtio_blk_submit_multireq(req->dev->blk, mrb);
553 }
554
555 assert(mrb->num_reqs < VIRTIO_BLK_MAX_MERGE_REQS);
556 mrb->reqs[mrb->num_reqs++] = req;
557 mrb->is_write = is_write;
558 break;
559 }
560 case VIRTIO_BLK_T_FLUSH:
c20fd872 561 virtio_blk_handle_flush(req, mrb);
95f7142a
PL
562 break;
563 case VIRTIO_BLK_T_SCSI_CMD:
bc6694d4 564 virtio_blk_handle_scsi(req);
95f7142a
PL
565 break;
566 case VIRTIO_BLK_T_GET_ID:
567 {
2930b313 568 VirtIOBlock *s = req->dev;
569
a8686a9b
MA
570 /*
571 * NB: per existing s/n string convention the string is
572 * terminated by '\0' only when shorter than buffer.
573 */
2a30307f 574 const char *serial = s->conf.serial ? s->conf.serial : "";
a83ceea8
MM
575 size_t size = MIN(strlen(serial) + 1,
576 MIN(iov_size(in_iov, in_num),
577 VIRTIO_BLK_ID_BYTES));
578 iov_from_buf(in_iov, in_num, 0, serial, size);
2930b313 579 virtio_blk_req_complete(req, VIRTIO_BLK_S_OK);
671ec3f0 580 virtio_blk_free_request(req);
95f7142a
PL
581 break;
582 }
583 default:
9e72c450 584 virtio_blk_req_complete(req, VIRTIO_BLK_S_UNSUPP);
671ec3f0 585 virtio_blk_free_request(req);
bc6694d4
KW
586 }
587}
588
6e02c38d
AL
589static void virtio_blk_handle_output(VirtIODevice *vdev, VirtQueue *vq)
590{
1cc91b7d 591 VirtIOBlock *s = VIRTIO_BLK(vdev);
6e02c38d 592 VirtIOBlockReq *req;
95f7142a 593 MultiReqBuffer mrb = {};
6e02c38d 594
392808b4
SH
595 /* Some guests kick before setting VIRTIO_CONFIG_S_DRIVER_OK so start
596 * dataplane here instead of waiting for .set_status().
597 */
598 if (s->dataplane) {
599 virtio_blk_data_plane_start(s->dataplane);
600 return;
601 }
392808b4 602
fc73548e
SH
603 blk_io_plug(s->blk);
604
6e02c38d 605 while ((req = virtio_blk_get_request(s))) {
bc6694d4 606 virtio_blk_handle_request(req, &mrb);
6e02c38d 607 }
91553dcc 608
95f7142a
PL
609 if (mrb.num_reqs) {
610 virtio_blk_submit_multireq(s->blk, &mrb);
611 }
fc73548e
SH
612
613 blk_io_unplug(s->blk);
6e02c38d
AL
614}
615
213189ab 616static void virtio_blk_dma_restart_bh(void *opaque)
869a5c6d
AL
617{
618 VirtIOBlock *s = opaque;
619 VirtIOBlockReq *req = s->rq;
95f7142a 620 MultiReqBuffer mrb = {};
869a5c6d 621
213189ab
MA
622 qemu_bh_delete(s->bh);
623 s->bh = NULL;
869a5c6d
AL
624
625 s->rq = NULL;
626
627 while (req) {
1bdb176a 628 VirtIOBlockReq *next = req->next;
f1b52868 629 virtio_blk_handle_request(req, &mrb);
1bdb176a 630 req = next;
869a5c6d 631 }
f1b52868 632
95f7142a
PL
633 if (mrb.num_reqs) {
634 virtio_blk_submit_multireq(s->blk, &mrb);
635 }
869a5c6d
AL
636}
637
1dfb4dd9
LC
638static void virtio_blk_dma_restart_cb(void *opaque, int running,
639 RunState state)
213189ab
MA
640{
641 VirtIOBlock *s = opaque;
642
392808b4 643 if (!running) {
213189ab 644 return;
392808b4 645 }
213189ab
MA
646
647 if (!s->bh) {
4be74634 648 s->bh = aio_bh_new(blk_get_aio_context(s->conf.conf.blk),
4407c1c5 649 virtio_blk_dma_restart_bh, s);
213189ab
MA
650 qemu_bh_schedule(s->bh);
651 }
652}
653
6e02c38d
AL
654static void virtio_blk_reset(VirtIODevice *vdev)
655{
1cc91b7d 656 VirtIOBlock *s = VIRTIO_BLK(vdev);
6e40b3bf 657 AioContext *ctx;
392808b4 658
6e02c38d
AL
659 /*
660 * This should cancel pending requests, but can't do nicely until there
661 * are per-device request lists.
662 */
6e40b3bf
AY
663 ctx = blk_get_aio_context(s->blk);
664 aio_context_acquire(ctx);
665 blk_drain(s->blk);
666
667 if (s->dataplane) {
668 virtio_blk_data_plane_stop(s->dataplane);
669 }
670 aio_context_release(ctx);
671
4be74634 672 blk_set_enable_write_cache(s->blk, s->original_wce);
6e02c38d
AL
673}
674
bf011293 675/* coalesce internal state, copy to pci i/o region 0
676 */
6e02c38d
AL
677static void virtio_blk_update_config(VirtIODevice *vdev, uint8_t *config)
678{
1cc91b7d 679 VirtIOBlock *s = VIRTIO_BLK(vdev);
2a30307f 680 BlockConf *conf = &s->conf.conf;
6e02c38d
AL
681 struct virtio_blk_config blkcfg;
682 uint64_t capacity;
f7516731 683 int blk_size = conf->logical_block_size;
6e02c38d 684
4be74634 685 blk_get_geometry(s->blk, &capacity);
5c5dafdc 686 memset(&blkcfg, 0, sizeof(blkcfg));
783d1897
RR
687 virtio_stq_p(vdev, &blkcfg.capacity, capacity);
688 virtio_stl_p(vdev, &blkcfg.seg_max, 128 - 2);
907eb3e5 689 virtio_stw_p(vdev, &blkcfg.geometry.cylinders, conf->cyls);
783d1897 690 virtio_stl_p(vdev, &blkcfg.blk_size, blk_size);
f7516731
MA
691 virtio_stw_p(vdev, &blkcfg.min_io_size, conf->min_io_size / blk_size);
692 virtio_stw_p(vdev, &blkcfg.opt_io_size, conf->opt_io_size / blk_size);
907eb3e5 693 blkcfg.geometry.heads = conf->heads;
136be99e
CB
694 /*
695 * We must ensure that the block device capacity is a multiple of
e03ba136 696 * the logical block size. If that is not the case, let's use
136be99e
CB
697 * sector_mask to adopt the geometry to have a correct picture.
698 * For those devices where the capacity is ok for the given geometry
e03ba136 699 * we don't touch the sector value of the geometry, since some devices
136be99e
CB
700 * (like s390 dasd) need a specific value. Here the capacity is already
701 * cyls*heads*secs*blk_size and the sector value is not block size
702 * divided by 512 - instead it is the amount of blk_size blocks
703 * per track (cylinder).
704 */
4be74634 705 if (blk_getlength(s->blk) / conf->heads / conf->secs % blk_size) {
907eb3e5 706 blkcfg.geometry.sectors = conf->secs & ~s->sector_mask;
136be99e 707 } else {
907eb3e5 708 blkcfg.geometry.sectors = conf->secs;
136be99e 709 }
c7085da7 710 blkcfg.size_max = 0;
f7516731 711 blkcfg.physical_block_exp = get_physical_block_exp(conf);
9752c371 712 blkcfg.alignment_offset = 0;
4be74634 713 blkcfg.wce = blk_enable_write_cache(s->blk);
37d5ddd6 714 memcpy(config, &blkcfg, sizeof(struct virtio_blk_config));
6e02c38d
AL
715}
716
13e3dce0
PB
717static void virtio_blk_set_config(VirtIODevice *vdev, const uint8_t *config)
718{
1cc91b7d 719 VirtIOBlock *s = VIRTIO_BLK(vdev);
13e3dce0
PB
720 struct virtio_blk_config blkcfg;
721
722 memcpy(&blkcfg, config, sizeof(blkcfg));
6d7e73d6 723
4be74634
MA
724 aio_context_acquire(blk_get_aio_context(s->blk));
725 blk_set_enable_write_cache(s->blk, blkcfg.wce != 0);
726 aio_context_release(blk_get_aio_context(s->blk));
13e3dce0
PB
727}
728
9d5b731d
JW
729static uint64_t virtio_blk_get_features(VirtIODevice *vdev, uint64_t features,
730 Error **errp)
6e02c38d 731{
1cc91b7d 732 VirtIOBlock *s = VIRTIO_BLK(vdev);
1063b8b1 733
0cd09c3a
CH
734 virtio_add_feature(&features, VIRTIO_BLK_F_SEG_MAX);
735 virtio_add_feature(&features, VIRTIO_BLK_F_GEOMETRY);
736 virtio_add_feature(&features, VIRTIO_BLK_F_TOPOLOGY);
737 virtio_add_feature(&features, VIRTIO_BLK_F_BLK_SIZE);
95129d6f 738 if (virtio_has_feature(features, VIRTIO_F_VERSION_1)) {
efb8206c
JW
739 if (s->conf.scsi) {
740 error_setg(errp, "Please set scsi=off for virtio-blk devices in order to use virtio 1.0");
741 return 0;
742 }
efb8206c 743 } else {
c9b11f97 744 virtio_clear_feature(&features, VIRTIO_F_ANY_LAYOUT);
efb8206c
JW
745 virtio_add_feature(&features, VIRTIO_BLK_F_SCSI);
746 }
aa659be3 747
2a30307f 748 if (s->conf.config_wce) {
0cd09c3a 749 virtio_add_feature(&features, VIRTIO_BLK_F_CONFIG_WCE);
8a873ba7 750 }
4be74634 751 if (blk_enable_write_cache(s->blk)) {
0cd09c3a 752 virtio_add_feature(&features, VIRTIO_BLK_F_WCE);
4be74634
MA
753 }
754 if (blk_is_read_only(s->blk)) {
0cd09c3a 755 virtio_add_feature(&features, VIRTIO_BLK_F_RO);
4be74634 756 }
1063b8b1
CH
757
758 return features;
6e02c38d
AL
759}
760
9315cbfd
PB
761static void virtio_blk_set_status(VirtIODevice *vdev, uint8_t status)
762{
1cc91b7d 763 VirtIOBlock *s = VIRTIO_BLK(vdev);
9315cbfd 764
cf139388
SH
765 if (s->dataplane && !(status & (VIRTIO_CONFIG_S_DRIVER |
766 VIRTIO_CONFIG_S_DRIVER_OK))) {
392808b4
SH
767 virtio_blk_data_plane_stop(s->dataplane);
768 }
392808b4 769
9315cbfd
PB
770 if (!(status & VIRTIO_CONFIG_S_DRIVER_OK)) {
771 return;
772 }
773
ef5bc962
PB
774 /* A guest that supports VIRTIO_BLK_F_CONFIG_WCE must be able to send
775 * cache flushes. Thus, the "auto writethrough" behavior is never
776 * necessary for guests that support the VIRTIO_BLK_F_CONFIG_WCE feature.
777 * Leaving it enabled would break the following sequence:
778 *
779 * Guest started with "-drive cache=writethrough"
780 * Guest sets status to 0
781 * Guest sets DRIVER bit in status field
782 * Guest reads host features (WCE=0, CONFIG_WCE=1)
783 * Guest writes guest features (WCE=0, CONFIG_WCE=1)
784 * Guest writes 1 to the WCE configuration field (writeback mode)
785 * Guest sets DRIVER_OK bit in status field
786 *
4be74634 787 * s->blk would erroneously be placed in writethrough mode.
ef5bc962 788 */
95129d6f 789 if (!virtio_vdev_has_feature(vdev, VIRTIO_BLK_F_CONFIG_WCE)) {
4be74634
MA
790 aio_context_acquire(blk_get_aio_context(s->blk));
791 blk_set_enable_write_cache(s->blk,
95129d6f
CH
792 virtio_vdev_has_feature(vdev,
793 VIRTIO_BLK_F_WCE));
4be74634 794 aio_context_release(blk_get_aio_context(s->blk));
ef5bc962 795 }
9315cbfd
PB
796}
797
6e02c38d
AL
798static void virtio_blk_save(QEMUFile *f, void *opaque)
799{
b2b295a7 800 VirtIODevice *vdev = VIRTIO_DEVICE(opaque);
869a5c6d 801
1cc91b7d 802 virtio_save(vdev, f);
b2b295a7 803}
869a5c6d 804
b2b295a7
GK
805static void virtio_blk_save_device(VirtIODevice *vdev, QEMUFile *f)
806{
807 VirtIOBlock *s = VIRTIO_BLK(vdev);
808 VirtIOBlockReq *req = s->rq;
809
869a5c6d
AL
810 while (req) {
811 qemu_put_sbyte(f, 1);
f897bf75 812 qemu_put_buffer(f, (unsigned char *)&req->elem,
671ec3f0 813 sizeof(VirtQueueElement));
869a5c6d
AL
814 req = req->next;
815 }
816 qemu_put_sbyte(f, 0);
6e02c38d
AL
817}
818
819static int virtio_blk_load(QEMUFile *f, void *opaque, int version_id)
820{
821 VirtIOBlock *s = opaque;
1cc91b7d 822 VirtIODevice *vdev = VIRTIO_DEVICE(s);
6e02c38d 823
869a5c6d 824 if (version_id != 2)
6e02c38d
AL
825 return -EINVAL;
826
b2b295a7
GK
827 return virtio_load(vdev, f, version_id);
828}
829
830static int virtio_blk_load_device(VirtIODevice *vdev, QEMUFile *f,
831 int version_id)
832{
833 VirtIOBlock *s = VIRTIO_BLK(vdev);
2a633c46 834
869a5c6d
AL
835 while (qemu_get_sbyte(f)) {
836 VirtIOBlockReq *req = virtio_blk_alloc_request(s);
f897bf75 837 qemu_get_buffer(f, (unsigned char *)&req->elem,
671ec3f0 838 sizeof(VirtQueueElement));
869a5c6d 839 req->next = s->rq;
20a81e4d 840 s->rq = req;
b6a4805b 841
3d8db153 842 virtqueue_map(&req->elem);
869a5c6d 843 }
6e02c38d
AL
844
845 return 0;
846}
847
145feb17 848static void virtio_blk_resize(void *opaque)
e5051fc7 849{
1cc91b7d 850 VirtIODevice *vdev = VIRTIO_DEVICE(opaque);
e5051fc7 851
1cc91b7d 852 virtio_notify_config(vdev);
e5051fc7
CH
853}
854
0e49de52 855static const BlockDevOps virtio_block_ops = {
145feb17 856 .resize_cb = virtio_blk_resize,
0e49de52
MA
857};
858
84db52d0
SH
859/* Disable dataplane thread during live migration since it does not
860 * update the dirty memory bitmap yet.
861 */
862static void virtio_blk_migration_state_changed(Notifier *notifier, void *data)
863{
864 VirtIOBlock *s = container_of(notifier, VirtIOBlock,
865 migration_state_notifier);
866 MigrationState *mig = data;
3ffeeef7 867 Error *err = NULL;
84db52d0
SH
868
869 if (migration_in_setup(mig)) {
870 if (!s->dataplane) {
871 return;
872 }
873 virtio_blk_data_plane_destroy(s->dataplane);
874 s->dataplane = NULL;
875 } else if (migration_has_finished(mig) ||
876 migration_has_failed(mig)) {
877 if (s->dataplane) {
878 return;
879 }
4be74634 880 blk_drain_all(); /* complete in-flight non-dataplane requests */
2a30307f 881 virtio_blk_data_plane_create(VIRTIO_DEVICE(s), &s->conf,
3ffeeef7
AF
882 &s->dataplane, &err);
883 if (err != NULL) {
565f65d2 884 error_report_err(err);
3ffeeef7 885 }
84db52d0
SH
886 }
887}
84db52d0 888
75884afd 889static void virtio_blk_device_realize(DeviceState *dev, Error **errp)
1c028ddf 890{
75884afd 891 VirtIODevice *vdev = VIRTIO_DEVICE(dev);
179b417e 892 VirtIOBlock *s = VIRTIO_BLK(dev);
2a30307f 893 VirtIOBlkConf *conf = &s->conf;
3ffeeef7 894 Error *err = NULL;
6e02c38d 895 static int virtio_blk_id;
cf21e106 896
4be74634 897 if (!conf->conf.blk) {
75884afd
AF
898 error_setg(errp, "drive property not set");
899 return;
d75d25e3 900 }
4be74634 901 if (!blk_is_inserted(conf->conf.blk)) {
75884afd
AF
902 error_setg(errp, "Device needs media, but drive is empty");
903 return;
98f28ad7 904 }
d75d25e3 905
2a30307f 906 blkconf_serial(&conf->conf, &conf->serial);
4be74634 907 s->original_wce = blk_enable_write_cache(conf->conf.blk);
2a30307f 908 blkconf_geometry(&conf->conf, NULL, 65535, 255, 255, &err);
5ff5efb4
FZ
909 if (err) {
910 error_propagate(errp, err);
75884afd 911 return;
b7eb0c9f 912 }
0eb28a42 913 blkconf_blocksizes(&conf->conf);
a8686a9b 914
05ff6865
FK
915 virtio_init(vdev, "virtio-blk", VIRTIO_ID_BLOCK,
916 sizeof(struct virtio_blk_config));
6e02c38d 917
4be74634 918 s->blk = conf->conf.blk;
869a5c6d 919 s->rq = NULL;
2a30307f 920 s->sector_mask = (s->conf.conf.logical_block_size / BDRV_SECTOR_SIZE) - 1;
e63e7fde 921
05ff6865 922 s->vq = virtio_add_queue(vdev, 128, virtio_blk_handle_output);
bf4bd461 923 s->complete_request = virtio_blk_complete_request;
2a30307f 924 virtio_blk_data_plane_create(vdev, conf, &s->dataplane, &err);
3ffeeef7 925 if (err != NULL) {
75884afd 926 error_propagate(errp, err);
6a1a8cc7 927 virtio_cleanup(vdev);
75884afd 928 return;
392808b4 929 }
84db52d0
SH
930 s->migration_state_notifier.notify = virtio_blk_migration_state_changed;
931 add_migration_state_change_notifier(&s->migration_state_notifier);
6e02c38d 932
69b302b2 933 s->change = qemu_add_vm_change_state_handler(virtio_blk_dma_restart_cb, s);
179b417e 934 register_savevm(dev, "virtio-blk", virtio_blk_id++, 2,
6e02c38d 935 virtio_blk_save, virtio_blk_load, s);
4be74634
MA
936 blk_set_dev_ops(s->blk, &virtio_block_ops, s);
937 blk_set_guest_block_size(s->blk, s->conf.conf.logical_block_size);
6e02c38d 938
4be74634 939 blk_iostatus_enable(s->blk);
1c028ddf
FK
940}
941
306ec6c3 942static void virtio_blk_device_unrealize(DeviceState *dev, Error **errp)
1c028ddf 943{
306ec6c3
AF
944 VirtIODevice *vdev = VIRTIO_DEVICE(dev);
945 VirtIOBlock *s = VIRTIO_BLK(dev);
946
84db52d0 947 remove_migration_state_change_notifier(&s->migration_state_notifier);
1c028ddf
FK
948 virtio_blk_data_plane_destroy(s->dataplane);
949 s->dataplane = NULL;
1c028ddf 950 qemu_del_vm_change_state_handler(s->change);
306ec6c3 951 unregister_savevm(dev, "virtio-blk", s);
4be74634 952 blockdev_mark_auto_del(s->blk);
6a1a8cc7 953 virtio_cleanup(vdev);
1c028ddf
FK
954}
955
467b3f33
SH
956static void virtio_blk_instance_init(Object *obj)
957{
958 VirtIOBlock *s = VIRTIO_BLK(obj);
959
960 object_property_add_link(obj, "iothread", TYPE_IOTHREAD,
2a30307f 961 (Object **)&s->conf.iothread,
467b3f33
SH
962 qdev_prop_allow_set_link_before_realize,
963 OBJ_PROP_LINK_UNREF_ON_RELEASE, NULL);
2a30307f 964 device_add_bootindex_property(obj, &s->conf.conf.bootindex,
3342ec32
GA
965 "bootindex", "/disk@0,0",
966 DEVICE(obj), NULL);
467b3f33
SH
967}
968
1c028ddf 969static Property virtio_blk_properties[] = {
2a30307f
MA
970 DEFINE_BLOCK_PROPERTIES(VirtIOBlock, conf.conf),
971 DEFINE_BLOCK_CHS_PROPERTIES(VirtIOBlock, conf.conf),
972 DEFINE_PROP_STRING("serial", VirtIOBlock, conf.serial),
973 DEFINE_PROP_BIT("config-wce", VirtIOBlock, conf.config_wce, 0, true),
32a877e4 974#ifdef __linux__
2a30307f 975 DEFINE_PROP_BIT("scsi", VirtIOBlock, conf.scsi, 0, true),
32a877e4 976#endif
c99495ac
PL
977 DEFINE_PROP_BIT("request-merging", VirtIOBlock, conf.request_merging, 0,
978 true),
2a30307f 979 DEFINE_PROP_BIT("x-data-plane", VirtIOBlock, conf.data_plane, 0, false),
1c028ddf
FK
980 DEFINE_PROP_END_OF_LIST(),
981};
982
983static void virtio_blk_class_init(ObjectClass *klass, void *data)
984{
985 DeviceClass *dc = DEVICE_CLASS(klass);
986 VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
75884afd 987
1c028ddf 988 dc->props = virtio_blk_properties;
125ee0ed 989 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
75884afd 990 vdc->realize = virtio_blk_device_realize;
306ec6c3 991 vdc->unrealize = virtio_blk_device_unrealize;
1c028ddf
FK
992 vdc->get_config = virtio_blk_update_config;
993 vdc->set_config = virtio_blk_set_config;
994 vdc->get_features = virtio_blk_get_features;
995 vdc->set_status = virtio_blk_set_status;
996 vdc->reset = virtio_blk_reset;
b2b295a7
GK
997 vdc->save = virtio_blk_save_device;
998 vdc->load = virtio_blk_load_device;
1c028ddf
FK
999}
1000
1001static const TypeInfo virtio_device_info = {
1002 .name = TYPE_VIRTIO_BLK,
1003 .parent = TYPE_VIRTIO_DEVICE,
1004 .instance_size = sizeof(VirtIOBlock),
467b3f33 1005 .instance_init = virtio_blk_instance_init,
1c028ddf
FK
1006 .class_init = virtio_blk_class_init,
1007};
1008
1009static void virtio_register_types(void)
1010{
1011 type_register_static(&virtio_device_info);
1012}
1013
1014type_init(virtio_register_types)