2 * xen paravirt block device backend
4 * (c) Gerd Hoffmann <kraxel@redhat.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; under version 2 of the License.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, see <http://www.gnu.org/licenses/>.
18 * Contributions after 2012-01-13 are licensed under the terms of the
19 * GNU GPL, version 2 or (at your option) any later version.
22 #include "qemu/osdep.h"
23 #include <sys/ioctl.h>
27 #include "hw/xen/xen_backend.h"
28 #include "xen_blkif.h"
29 #include "sysemu/blockdev.h"
30 #include "sysemu/iothread.h"
31 #include "sysemu/block-backend.h"
32 #include "qapi/error.h"
33 #include "qapi/qmp/qdict.h"
34 #include "qapi/qmp/qstring.h"
37 /* ------------------------------------------------------------- */
39 static int batch_maps
= 0;
41 /* ------------------------------------------------------------- */
43 #define BLOCK_SIZE 512
44 #define IOCB_COUNT (BLKIF_MAX_SEGMENTS_PER_REQUEST + 2)
46 struct PersistentGrant
{
48 struct XenBlkDev
*blkdev
;
51 typedef struct PersistentGrant PersistentGrant
;
53 struct PersistentRegion
{
58 typedef struct PersistentRegion PersistentRegion
;
71 uint32_t domids
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
72 uint32_t refs
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
74 void *page
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
82 struct XenBlkDev
*blkdev
;
83 QLIST_ENTRY(ioreq
) list
;
87 #define MAX_RING_PAGE_ORDER 4
90 struct XenDevice xendev
; /* must be first */
97 const char *fileproto
;
99 unsigned int ring_ref
[1 << MAX_RING_PAGE_ORDER
];
100 unsigned int nr_ring_ref
;
105 blkif_back_rings_t rings
;
110 QLIST_HEAD(inflight_head
, ioreq
) inflight
;
111 QLIST_HEAD(finished_head
, ioreq
) finished
;
112 QLIST_HEAD(freelist_head
, ioreq
) freelist
;
114 int requests_inflight
;
115 int requests_finished
;
116 unsigned int max_requests
;
118 /* Persistent grants extension */
119 gboolean feature_discard
;
120 gboolean feature_persistent
;
121 GTree
*persistent_gnts
;
122 GSList
*persistent_regions
;
123 unsigned int persistent_gnt_count
;
124 unsigned int max_grants
;
126 /* qemu block driver */
135 /* ------------------------------------------------------------- */
137 static void ioreq_reset(struct ioreq
*ioreq
)
139 memset(&ioreq
->req
, 0, sizeof(ioreq
->req
));
145 memset(ioreq
->domids
, 0, sizeof(ioreq
->domids
));
146 memset(ioreq
->refs
, 0, sizeof(ioreq
->refs
));
148 memset(ioreq
->page
, 0, sizeof(ioreq
->page
));
151 ioreq
->aio_inflight
= 0;
152 ioreq
->aio_errors
= 0;
154 ioreq
->blkdev
= NULL
;
155 memset(&ioreq
->list
, 0, sizeof(ioreq
->list
));
156 memset(&ioreq
->acct
, 0, sizeof(ioreq
->acct
));
158 qemu_iovec_reset(&ioreq
->v
);
161 static gint
int_cmp(gconstpointer a
, gconstpointer b
, gpointer user_data
)
163 uint ua
= GPOINTER_TO_UINT(a
);
164 uint ub
= GPOINTER_TO_UINT(b
);
165 return (ua
> ub
) - (ua
< ub
);
168 static void destroy_grant(gpointer pgnt
)
170 PersistentGrant
*grant
= pgnt
;
171 xengnttab_handle
*gnt
= grant
->blkdev
->xendev
.gnttabdev
;
173 if (xengnttab_unmap(gnt
, grant
->page
, 1) != 0) {
174 xen_pv_printf(&grant
->blkdev
->xendev
, 0,
175 "xengnttab_unmap failed: %s\n",
178 grant
->blkdev
->persistent_gnt_count
--;
179 xen_pv_printf(&grant
->blkdev
->xendev
, 3,
180 "unmapped grant %p\n", grant
->page
);
184 static void remove_persistent_region(gpointer data
, gpointer dev
)
186 PersistentRegion
*region
= data
;
187 struct XenBlkDev
*blkdev
= dev
;
188 xengnttab_handle
*gnt
= blkdev
->xendev
.gnttabdev
;
190 if (xengnttab_unmap(gnt
, region
->addr
, region
->num
) != 0) {
191 xen_pv_printf(&blkdev
->xendev
, 0,
192 "xengnttab_unmap region %p failed: %s\n",
193 region
->addr
, strerror(errno
));
195 xen_pv_printf(&blkdev
->xendev
, 3,
196 "unmapped grant region %p with %d pages\n",
197 region
->addr
, region
->num
);
201 static struct ioreq
*ioreq_start(struct XenBlkDev
*blkdev
)
203 struct ioreq
*ioreq
= NULL
;
205 if (QLIST_EMPTY(&blkdev
->freelist
)) {
206 if (blkdev
->requests_total
>= blkdev
->max_requests
) {
209 /* allocate new struct */
210 ioreq
= g_malloc0(sizeof(*ioreq
));
211 ioreq
->blkdev
= blkdev
;
212 blkdev
->requests_total
++;
213 qemu_iovec_init(&ioreq
->v
, BLKIF_MAX_SEGMENTS_PER_REQUEST
);
215 /* get one from freelist */
216 ioreq
= QLIST_FIRST(&blkdev
->freelist
);
217 QLIST_REMOVE(ioreq
, list
);
219 QLIST_INSERT_HEAD(&blkdev
->inflight
, ioreq
, list
);
220 blkdev
->requests_inflight
++;
226 static void ioreq_finish(struct ioreq
*ioreq
)
228 struct XenBlkDev
*blkdev
= ioreq
->blkdev
;
230 QLIST_REMOVE(ioreq
, list
);
231 QLIST_INSERT_HEAD(&blkdev
->finished
, ioreq
, list
);
232 blkdev
->requests_inflight
--;
233 blkdev
->requests_finished
++;
236 static void ioreq_release(struct ioreq
*ioreq
, bool finish
)
238 struct XenBlkDev
*blkdev
= ioreq
->blkdev
;
240 QLIST_REMOVE(ioreq
, list
);
242 ioreq
->blkdev
= blkdev
;
243 QLIST_INSERT_HEAD(&blkdev
->freelist
, ioreq
, list
);
245 blkdev
->requests_finished
--;
247 blkdev
->requests_inflight
--;
252 * translate request into iovec + start offset
253 * do sanity checks along the way
255 static int ioreq_parse(struct ioreq
*ioreq
)
257 struct XenBlkDev
*blkdev
= ioreq
->blkdev
;
262 xen_pv_printf(&blkdev
->xendev
, 3,
263 "op %d, nr %d, handle %d, id %" PRId64
", sector %" PRId64
"\n",
264 ioreq
->req
.operation
, ioreq
->req
.nr_segments
,
265 ioreq
->req
.handle
, ioreq
->req
.id
, ioreq
->req
.sector_number
);
266 switch (ioreq
->req
.operation
) {
268 ioreq
->prot
= PROT_WRITE
; /* to memory */
270 case BLKIF_OP_FLUSH_DISKCACHE
:
272 if (!ioreq
->req
.nr_segments
) {
277 ioreq
->prot
= PROT_READ
; /* from memory */
279 case BLKIF_OP_DISCARD
:
282 xen_pv_printf(&blkdev
->xendev
, 0, "error: unknown operation (%d)\n",
283 ioreq
->req
.operation
);
287 if (ioreq
->req
.operation
!= BLKIF_OP_READ
&& blkdev
->mode
[0] != 'w') {
288 xen_pv_printf(&blkdev
->xendev
, 0, "error: write req for ro device\n");
292 ioreq
->start
= ioreq
->req
.sector_number
* blkdev
->file_blk
;
293 for (i
= 0; i
< ioreq
->req
.nr_segments
; i
++) {
294 if (i
== BLKIF_MAX_SEGMENTS_PER_REQUEST
) {
295 xen_pv_printf(&blkdev
->xendev
, 0, "error: nr_segments too big\n");
298 if (ioreq
->req
.seg
[i
].first_sect
> ioreq
->req
.seg
[i
].last_sect
) {
299 xen_pv_printf(&blkdev
->xendev
, 0, "error: first > last sector\n");
302 if (ioreq
->req
.seg
[i
].last_sect
* BLOCK_SIZE
>= XC_PAGE_SIZE
) {
303 xen_pv_printf(&blkdev
->xendev
, 0, "error: page crossing\n");
307 ioreq
->domids
[i
] = blkdev
->xendev
.dom
;
308 ioreq
->refs
[i
] = ioreq
->req
.seg
[i
].gref
;
310 mem
= ioreq
->req
.seg
[i
].first_sect
* blkdev
->file_blk
;
311 len
= (ioreq
->req
.seg
[i
].last_sect
- ioreq
->req
.seg
[i
].first_sect
+ 1) * blkdev
->file_blk
;
312 qemu_iovec_add(&ioreq
->v
, (void*)mem
, len
);
314 if (ioreq
->start
+ ioreq
->v
.size
> blkdev
->file_size
) {
315 xen_pv_printf(&blkdev
->xendev
, 0, "error: access beyond end of file\n");
321 ioreq
->status
= BLKIF_RSP_ERROR
;
325 static void ioreq_unmap(struct ioreq
*ioreq
)
327 xengnttab_handle
*gnt
= ioreq
->blkdev
->xendev
.gnttabdev
;
330 if (ioreq
->num_unmap
== 0 || ioreq
->mapped
== 0) {
337 if (xengnttab_unmap(gnt
, ioreq
->pages
, ioreq
->num_unmap
) != 0) {
338 xen_pv_printf(&ioreq
->blkdev
->xendev
, 0,
339 "xengnttab_unmap failed: %s\n",
342 ioreq
->blkdev
->cnt_map
-= ioreq
->num_unmap
;
345 for (i
= 0; i
< ioreq
->num_unmap
; i
++) {
346 if (!ioreq
->page
[i
]) {
349 if (xengnttab_unmap(gnt
, ioreq
->page
[i
], 1) != 0) {
350 xen_pv_printf(&ioreq
->blkdev
->xendev
, 0,
351 "xengnttab_unmap failed: %s\n",
354 ioreq
->blkdev
->cnt_map
--;
355 ioreq
->page
[i
] = NULL
;
361 static int ioreq_map(struct ioreq
*ioreq
)
363 xengnttab_handle
*gnt
= ioreq
->blkdev
->xendev
.gnttabdev
;
364 uint32_t domids
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
365 uint32_t refs
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
366 void *page
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
367 int i
, j
, new_maps
= 0;
368 PersistentGrant
*grant
;
369 PersistentRegion
*region
;
370 /* domids and refs variables will contain the information necessary
371 * to map the grants that are needed to fulfill this request.
373 * After mapping the needed grants, the page array will contain the
374 * memory address of each granted page in the order specified in ioreq
375 * (disregarding if it's a persistent grant or not).
378 if (ioreq
->v
.niov
== 0 || ioreq
->mapped
== 1) {
381 if (ioreq
->blkdev
->feature_persistent
) {
382 for (i
= 0; i
< ioreq
->v
.niov
; i
++) {
383 grant
= g_tree_lookup(ioreq
->blkdev
->persistent_gnts
,
384 GUINT_TO_POINTER(ioreq
->refs
[i
]));
387 page
[i
] = grant
->page
;
388 xen_pv_printf(&ioreq
->blkdev
->xendev
, 3,
389 "using persistent-grant %" PRIu32
"\n",
392 /* Add the grant to the list of grants that
395 domids
[new_maps
] = ioreq
->domids
[i
];
396 refs
[new_maps
] = ioreq
->refs
[i
];
401 /* Set the protection to RW, since grants may be reused later
402 * with a different protection than the one needed for this request
404 ioreq
->prot
= PROT_WRITE
| PROT_READ
;
406 /* All grants in the request should be mapped */
407 memcpy(refs
, ioreq
->refs
, sizeof(refs
));
408 memcpy(domids
, ioreq
->domids
, sizeof(domids
));
409 memset(page
, 0, sizeof(page
));
410 new_maps
= ioreq
->v
.niov
;
413 if (batch_maps
&& new_maps
) {
414 ioreq
->pages
= xengnttab_map_grant_refs
415 (gnt
, new_maps
, domids
, refs
, ioreq
->prot
);
416 if (ioreq
->pages
== NULL
) {
417 xen_pv_printf(&ioreq
->blkdev
->xendev
, 0,
418 "can't map %d grant refs (%s, %d maps)\n",
419 new_maps
, strerror(errno
), ioreq
->blkdev
->cnt_map
);
422 for (i
= 0, j
= 0; i
< ioreq
->v
.niov
; i
++) {
423 if (page
[i
] == NULL
) {
424 page
[i
] = ioreq
->pages
+ (j
++) * XC_PAGE_SIZE
;
427 ioreq
->blkdev
->cnt_map
+= new_maps
;
428 } else if (new_maps
) {
429 for (i
= 0; i
< new_maps
; i
++) {
430 ioreq
->page
[i
] = xengnttab_map_grant_ref
431 (gnt
, domids
[i
], refs
[i
], ioreq
->prot
);
432 if (ioreq
->page
[i
] == NULL
) {
433 xen_pv_printf(&ioreq
->blkdev
->xendev
, 0,
434 "can't map grant ref %d (%s, %d maps)\n",
435 refs
[i
], strerror(errno
), ioreq
->blkdev
->cnt_map
);
440 ioreq
->blkdev
->cnt_map
++;
442 for (i
= 0, j
= 0; i
< ioreq
->v
.niov
; i
++) {
443 if (page
[i
] == NULL
) {
444 page
[i
] = ioreq
->page
[j
++];
448 if (ioreq
->blkdev
->feature_persistent
&& new_maps
!= 0 &&
449 (!batch_maps
|| (ioreq
->blkdev
->persistent_gnt_count
+ new_maps
<=
450 ioreq
->blkdev
->max_grants
))) {
452 * If we are using persistent grants and batch mappings only
453 * add the new maps to the list of persistent grants if the whole
454 * area can be persistently mapped.
457 region
= g_malloc0(sizeof(*region
));
458 region
->addr
= ioreq
->pages
;
459 region
->num
= new_maps
;
460 ioreq
->blkdev
->persistent_regions
= g_slist_append(
461 ioreq
->blkdev
->persistent_regions
,
464 while ((ioreq
->blkdev
->persistent_gnt_count
< ioreq
->blkdev
->max_grants
)
466 /* Go through the list of newly mapped grants and add as many
467 * as possible to the list of persistently mapped grants.
469 * Since we start at the end of ioreq->page(s), we only need
470 * to decrease new_maps to prevent this granted pages from
471 * being unmapped in ioreq_unmap.
473 grant
= g_malloc0(sizeof(*grant
));
476 grant
->page
= ioreq
->pages
+ (new_maps
) * XC_PAGE_SIZE
;
478 grant
->page
= ioreq
->page
[new_maps
];
480 grant
->blkdev
= ioreq
->blkdev
;
481 xen_pv_printf(&ioreq
->blkdev
->xendev
, 3,
482 "adding grant %" PRIu32
" page: %p\n",
483 refs
[new_maps
], grant
->page
);
484 g_tree_insert(ioreq
->blkdev
->persistent_gnts
,
485 GUINT_TO_POINTER(refs
[new_maps
]),
487 ioreq
->blkdev
->persistent_gnt_count
++;
489 assert(!batch_maps
|| new_maps
== 0);
491 for (i
= 0; i
< ioreq
->v
.niov
; i
++) {
492 ioreq
->v
.iov
[i
].iov_base
+= (uintptr_t)page
[i
];
495 ioreq
->num_unmap
= new_maps
;
499 #if CONFIG_XEN_CTRL_INTERFACE_VERSION >= 40800
501 static void ioreq_free_copy_buffers(struct ioreq
*ioreq
)
505 for (i
= 0; i
< ioreq
->v
.niov
; i
++) {
506 ioreq
->page
[i
] = NULL
;
509 qemu_vfree(ioreq
->pages
);
512 static int ioreq_init_copy_buffers(struct ioreq
*ioreq
)
516 if (ioreq
->v
.niov
== 0) {
520 ioreq
->pages
= qemu_memalign(XC_PAGE_SIZE
, ioreq
->v
.niov
* XC_PAGE_SIZE
);
522 for (i
= 0; i
< ioreq
->v
.niov
; i
++) {
523 ioreq
->page
[i
] = ioreq
->pages
+ i
* XC_PAGE_SIZE
;
524 ioreq
->v
.iov
[i
].iov_base
= ioreq
->page
[i
];
530 static int ioreq_grant_copy(struct ioreq
*ioreq
)
532 xengnttab_handle
*gnt
= ioreq
->blkdev
->xendev
.gnttabdev
;
533 xengnttab_grant_copy_segment_t segs
[BLKIF_MAX_SEGMENTS_PER_REQUEST
];
535 int64_t file_blk
= ioreq
->blkdev
->file_blk
;
537 if (ioreq
->v
.niov
== 0) {
541 count
= ioreq
->v
.niov
;
543 for (i
= 0; i
< count
; i
++) {
544 if (ioreq
->req
.operation
== BLKIF_OP_READ
) {
545 segs
[i
].flags
= GNTCOPY_dest_gref
;
546 segs
[i
].dest
.foreign
.ref
= ioreq
->refs
[i
];
547 segs
[i
].dest
.foreign
.domid
= ioreq
->domids
[i
];
548 segs
[i
].dest
.foreign
.offset
= ioreq
->req
.seg
[i
].first_sect
* file_blk
;
549 segs
[i
].source
.virt
= ioreq
->v
.iov
[i
].iov_base
;
551 segs
[i
].flags
= GNTCOPY_source_gref
;
552 segs
[i
].source
.foreign
.ref
= ioreq
->refs
[i
];
553 segs
[i
].source
.foreign
.domid
= ioreq
->domids
[i
];
554 segs
[i
].source
.foreign
.offset
= ioreq
->req
.seg
[i
].first_sect
* file_blk
;
555 segs
[i
].dest
.virt
= ioreq
->v
.iov
[i
].iov_base
;
557 segs
[i
].len
= (ioreq
->req
.seg
[i
].last_sect
558 - ioreq
->req
.seg
[i
].first_sect
+ 1) * file_blk
;
561 rc
= xengnttab_grant_copy(gnt
, count
, segs
);
564 xen_pv_printf(&ioreq
->blkdev
->xendev
, 0,
565 "failed to copy data %d\n", rc
);
570 for (i
= 0; i
< count
; i
++) {
571 if (segs
[i
].status
!= GNTST_okay
) {
572 xen_pv_printf(&ioreq
->blkdev
->xendev
, 3,
573 "failed to copy data %d for gref %d, domid %d\n",
574 segs
[i
].status
, ioreq
->refs
[i
], ioreq
->domids
[i
]);
583 static void ioreq_free_copy_buffers(struct ioreq
*ioreq
)
588 static int ioreq_init_copy_buffers(struct ioreq
*ioreq
)
593 static int ioreq_grant_copy(struct ioreq
*ioreq
)
599 static int ioreq_runio_qemu_aio(struct ioreq
*ioreq
);
601 static void qemu_aio_complete(void *opaque
, int ret
)
603 struct ioreq
*ioreq
= opaque
;
604 struct XenBlkDev
*blkdev
= ioreq
->blkdev
;
606 aio_context_acquire(blkdev
->ctx
);
609 xen_pv_printf(&blkdev
->xendev
, 0, "%s I/O error\n",
610 ioreq
->req
.operation
== BLKIF_OP_READ
? "read" : "write");
614 ioreq
->aio_inflight
--;
615 if (ioreq
->presync
) {
617 ioreq_runio_qemu_aio(ioreq
);
620 if (ioreq
->aio_inflight
> 0) {
624 if (xen_feature_grant_copy
) {
625 switch (ioreq
->req
.operation
) {
627 /* in case of failure ioreq->aio_errors is increased */
629 ioreq_grant_copy(ioreq
);
631 ioreq_free_copy_buffers(ioreq
);
634 case BLKIF_OP_FLUSH_DISKCACHE
:
635 if (!ioreq
->req
.nr_segments
) {
638 ioreq_free_copy_buffers(ioreq
);
645 ioreq
->status
= ioreq
->aio_errors
? BLKIF_RSP_ERROR
: BLKIF_RSP_OKAY
;
646 if (!xen_feature_grant_copy
) {
650 switch (ioreq
->req
.operation
) {
652 case BLKIF_OP_FLUSH_DISKCACHE
:
653 if (!ioreq
->req
.nr_segments
) {
657 if (ioreq
->status
== BLKIF_RSP_OKAY
) {
658 block_acct_done(blk_get_stats(blkdev
->blk
), &ioreq
->acct
);
660 block_acct_failed(blk_get_stats(blkdev
->blk
), &ioreq
->acct
);
663 case BLKIF_OP_DISCARD
:
667 qemu_bh_schedule(blkdev
->bh
);
670 aio_context_release(blkdev
->ctx
);
673 static bool blk_split_discard(struct ioreq
*ioreq
, blkif_sector_t sector_number
,
676 struct XenBlkDev
*blkdev
= ioreq
->blkdev
;
679 uint64_t byte_remaining
, limit
;
680 uint64_t sec_start
= sector_number
;
681 uint64_t sec_count
= nr_sectors
;
683 /* Wrap around, or overflowing byte limit? */
684 if (sec_start
+ sec_count
< sec_count
||
685 sec_start
+ sec_count
> INT64_MAX
>> BDRV_SECTOR_BITS
) {
689 limit
= BDRV_REQUEST_MAX_SECTORS
<< BDRV_SECTOR_BITS
;
690 byte_offset
= sec_start
<< BDRV_SECTOR_BITS
;
691 byte_remaining
= sec_count
<< BDRV_SECTOR_BITS
;
694 byte_chunk
= byte_remaining
> limit
? limit
: byte_remaining
;
695 ioreq
->aio_inflight
++;
696 blk_aio_pdiscard(blkdev
->blk
, byte_offset
, byte_chunk
,
697 qemu_aio_complete
, ioreq
);
698 byte_remaining
-= byte_chunk
;
699 byte_offset
+= byte_chunk
;
700 } while (byte_remaining
> 0);
705 static int ioreq_runio_qemu_aio(struct ioreq
*ioreq
)
707 struct XenBlkDev
*blkdev
= ioreq
->blkdev
;
709 if (xen_feature_grant_copy
) {
710 ioreq_init_copy_buffers(ioreq
);
711 if (ioreq
->req
.nr_segments
&& (ioreq
->req
.operation
== BLKIF_OP_WRITE
||
712 ioreq
->req
.operation
== BLKIF_OP_FLUSH_DISKCACHE
) &&
713 ioreq_grant_copy(ioreq
)) {
714 ioreq_free_copy_buffers(ioreq
);
718 if (ioreq
->req
.nr_segments
&& ioreq_map(ioreq
)) {
723 ioreq
->aio_inflight
++;
724 if (ioreq
->presync
) {
725 blk_aio_flush(ioreq
->blkdev
->blk
, qemu_aio_complete
, ioreq
);
729 switch (ioreq
->req
.operation
) {
731 block_acct_start(blk_get_stats(blkdev
->blk
), &ioreq
->acct
,
732 ioreq
->v
.size
, BLOCK_ACCT_READ
);
733 ioreq
->aio_inflight
++;
734 blk_aio_preadv(blkdev
->blk
, ioreq
->start
, &ioreq
->v
, 0,
735 qemu_aio_complete
, ioreq
);
738 case BLKIF_OP_FLUSH_DISKCACHE
:
739 if (!ioreq
->req
.nr_segments
) {
743 block_acct_start(blk_get_stats(blkdev
->blk
), &ioreq
->acct
,
745 ioreq
->req
.operation
== BLKIF_OP_WRITE
?
746 BLOCK_ACCT_WRITE
: BLOCK_ACCT_FLUSH
);
747 ioreq
->aio_inflight
++;
748 blk_aio_pwritev(blkdev
->blk
, ioreq
->start
, &ioreq
->v
, 0,
749 qemu_aio_complete
, ioreq
);
751 case BLKIF_OP_DISCARD
:
753 struct blkif_request_discard
*req
= (void *)&ioreq
->req
;
754 if (!blk_split_discard(ioreq
, req
->sector_number
, req
->nr_sectors
)) {
760 /* unknown operation (shouldn't happen -- parse catches this) */
761 if (!xen_feature_grant_copy
) {
767 qemu_aio_complete(ioreq
, 0);
773 ioreq
->status
= BLKIF_RSP_ERROR
;
777 static int blk_send_response_one(struct ioreq
*ioreq
)
779 struct XenBlkDev
*blkdev
= ioreq
->blkdev
;
781 int have_requests
= 0;
782 blkif_response_t
*resp
;
784 /* Place on the response ring for the relevant domain. */
785 switch (blkdev
->protocol
) {
786 case BLKIF_PROTOCOL_NATIVE
:
787 resp
= (blkif_response_t
*) RING_GET_RESPONSE(&blkdev
->rings
.native
,
788 blkdev
->rings
.native
.rsp_prod_pvt
);
790 case BLKIF_PROTOCOL_X86_32
:
791 resp
= (blkif_response_t
*) RING_GET_RESPONSE(&blkdev
->rings
.x86_32_part
,
792 blkdev
->rings
.x86_32_part
.rsp_prod_pvt
);
794 case BLKIF_PROTOCOL_X86_64
:
795 resp
= (blkif_response_t
*) RING_GET_RESPONSE(&blkdev
->rings
.x86_64_part
,
796 blkdev
->rings
.x86_64_part
.rsp_prod_pvt
);
802 resp
->id
= ioreq
->req
.id
;
803 resp
->operation
= ioreq
->req
.operation
;
804 resp
->status
= ioreq
->status
;
806 blkdev
->rings
.common
.rsp_prod_pvt
++;
808 RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(&blkdev
->rings
.common
, send_notify
);
809 if (blkdev
->rings
.common
.rsp_prod_pvt
== blkdev
->rings
.common
.req_cons
) {
811 * Tail check for pending requests. Allows frontend to avoid
812 * notifications if requests are already in flight (lower
813 * overheads and promotes batching).
815 RING_FINAL_CHECK_FOR_REQUESTS(&blkdev
->rings
.common
, have_requests
);
816 } else if (RING_HAS_UNCONSUMED_REQUESTS(&blkdev
->rings
.common
)) {
826 /* walk finished list, send outstanding responses, free requests */
827 static void blk_send_response_all(struct XenBlkDev
*blkdev
)
832 while (!QLIST_EMPTY(&blkdev
->finished
)) {
833 ioreq
= QLIST_FIRST(&blkdev
->finished
);
834 send_notify
+= blk_send_response_one(ioreq
);
835 ioreq_release(ioreq
, true);
838 xen_pv_send_notify(&blkdev
->xendev
);
842 static int blk_get_request(struct XenBlkDev
*blkdev
, struct ioreq
*ioreq
, RING_IDX rc
)
844 switch (blkdev
->protocol
) {
845 case BLKIF_PROTOCOL_NATIVE
:
846 memcpy(&ioreq
->req
, RING_GET_REQUEST(&blkdev
->rings
.native
, rc
),
849 case BLKIF_PROTOCOL_X86_32
:
850 blkif_get_x86_32_req(&ioreq
->req
,
851 RING_GET_REQUEST(&blkdev
->rings
.x86_32_part
, rc
));
853 case BLKIF_PROTOCOL_X86_64
:
854 blkif_get_x86_64_req(&ioreq
->req
,
855 RING_GET_REQUEST(&blkdev
->rings
.x86_64_part
, rc
));
858 /* Prevent the compiler from accessing the on-ring fields instead. */
863 static void blk_handle_requests(struct XenBlkDev
*blkdev
)
868 blkdev
->more_work
= 0;
870 rc
= blkdev
->rings
.common
.req_cons
;
871 rp
= blkdev
->rings
.common
.sring
->req_prod
;
872 xen_rmb(); /* Ensure we see queued requests up to 'rp'. */
874 blk_send_response_all(blkdev
);
876 /* pull request from ring */
877 if (RING_REQUEST_CONS_OVERFLOW(&blkdev
->rings
.common
, rc
)) {
880 ioreq
= ioreq_start(blkdev
);
885 blk_get_request(blkdev
, ioreq
, rc
);
886 blkdev
->rings
.common
.req_cons
= ++rc
;
889 if (ioreq_parse(ioreq
) != 0) {
891 switch (ioreq
->req
.operation
) {
893 block_acct_invalid(blk_get_stats(blkdev
->blk
),
897 block_acct_invalid(blk_get_stats(blkdev
->blk
),
900 case BLKIF_OP_FLUSH_DISKCACHE
:
901 block_acct_invalid(blk_get_stats(blkdev
->blk
),
907 if (blk_send_response_one(ioreq
)) {
908 xen_pv_send_notify(&blkdev
->xendev
);
910 ioreq_release(ioreq
, false);
914 ioreq_runio_qemu_aio(ioreq
);
917 if (blkdev
->more_work
&& blkdev
->requests_inflight
< blkdev
->max_requests
) {
918 qemu_bh_schedule(blkdev
->bh
);
922 /* ------------------------------------------------------------- */
924 static void blk_bh(void *opaque
)
926 struct XenBlkDev
*blkdev
= opaque
;
928 aio_context_acquire(blkdev
->ctx
);
929 blk_handle_requests(blkdev
);
930 aio_context_release(blkdev
->ctx
);
933 static void blk_alloc(struct XenDevice
*xendev
)
935 struct XenBlkDev
*blkdev
= container_of(xendev
, struct XenBlkDev
, xendev
);
938 trace_xen_disk_alloc(xendev
->name
);
940 QLIST_INIT(&blkdev
->inflight
);
941 QLIST_INIT(&blkdev
->finished
);
942 QLIST_INIT(&blkdev
->freelist
);
944 blkdev
->iothread
= iothread_create(xendev
->name
, &err
);
947 blkdev
->ctx
= iothread_get_aio_context(blkdev
->iothread
);
948 blkdev
->bh
= aio_bh_new(blkdev
->ctx
, blk_bh
, blkdev
);
950 if (xen_mode
!= XEN_EMULATE
) {
955 static void blk_parse_discard(struct XenBlkDev
*blkdev
)
959 blkdev
->feature_discard
= true;
961 if (xenstore_read_be_int(&blkdev
->xendev
, "discard-enable", &enable
) == 0) {
962 blkdev
->feature_discard
= !!enable
;
965 if (blkdev
->feature_discard
) {
966 xenstore_write_be_int(&blkdev
->xendev
, "feature-discard", 1);
970 static int blk_init(struct XenDevice
*xendev
)
972 struct XenBlkDev
*blkdev
= container_of(xendev
, struct XenBlkDev
, xendev
);
974 char *directiosafe
= NULL
;
976 trace_xen_disk_init(xendev
->name
);
978 /* read xenstore entries */
979 if (blkdev
->params
== NULL
) {
981 blkdev
->params
= xenstore_read_be_str(&blkdev
->xendev
, "params");
982 if (blkdev
->params
!= NULL
) {
983 h
= strchr(blkdev
->params
, ':');
986 blkdev
->fileproto
= blkdev
->params
;
987 blkdev
->filename
= h
+1;
990 blkdev
->fileproto
= "<unset>";
991 blkdev
->filename
= blkdev
->params
;
994 if (!strcmp("aio", blkdev
->fileproto
)) {
995 blkdev
->fileproto
= "raw";
997 if (!strcmp("vhd", blkdev
->fileproto
)) {
998 blkdev
->fileproto
= "vpc";
1000 if (blkdev
->mode
== NULL
) {
1001 blkdev
->mode
= xenstore_read_be_str(&blkdev
->xendev
, "mode");
1003 if (blkdev
->type
== NULL
) {
1004 blkdev
->type
= xenstore_read_be_str(&blkdev
->xendev
, "type");
1006 if (blkdev
->dev
== NULL
) {
1007 blkdev
->dev
= xenstore_read_be_str(&blkdev
->xendev
, "dev");
1009 if (blkdev
->devtype
== NULL
) {
1010 blkdev
->devtype
= xenstore_read_be_str(&blkdev
->xendev
, "device-type");
1012 directiosafe
= xenstore_read_be_str(&blkdev
->xendev
, "direct-io-safe");
1013 blkdev
->directiosafe
= (directiosafe
&& atoi(directiosafe
));
1015 /* do we have all we need? */
1016 if (blkdev
->params
== NULL
||
1017 blkdev
->mode
== NULL
||
1018 blkdev
->type
== NULL
||
1019 blkdev
->dev
== NULL
) {
1024 if (strcmp(blkdev
->mode
, "w")) {
1025 info
|= VDISK_READONLY
;
1029 if (blkdev
->devtype
&& !strcmp(blkdev
->devtype
, "cdrom")) {
1030 info
|= VDISK_CDROM
;
1033 blkdev
->file_blk
= BLOCK_SIZE
;
1035 xen_pv_printf(&blkdev
->xendev
, 3, "grant copy operation %s\n",
1036 xen_feature_grant_copy
? "enabled" : "disabled");
1039 * blk_connect supplies sector-size and sectors
1041 xenstore_write_be_int(&blkdev
->xendev
, "feature-flush-cache", 1);
1042 xenstore_write_be_int(&blkdev
->xendev
, "feature-persistent",
1043 !xen_feature_grant_copy
);
1044 xenstore_write_be_int(&blkdev
->xendev
, "info", info
);
1046 xenstore_write_be_int(&blkdev
->xendev
, "max-ring-page-order",
1047 MAX_RING_PAGE_ORDER
);
1049 blk_parse_discard(blkdev
);
1051 g_free(directiosafe
);
1055 g_free(blkdev
->params
);
1056 blkdev
->params
= NULL
;
1057 g_free(blkdev
->mode
);
1058 blkdev
->mode
= NULL
;
1059 g_free(blkdev
->type
);
1060 blkdev
->type
= NULL
;
1061 g_free(blkdev
->dev
);
1063 g_free(blkdev
->devtype
);
1064 blkdev
->devtype
= NULL
;
1065 g_free(directiosafe
);
1066 blkdev
->directiosafe
= false;
1071 * We need to account for the grant allocations requiring contiguous
1072 * chunks; the worst case number would be
1073 * max_req * max_seg + (max_req - 1) * (max_seg - 1) + 1,
1074 * but in order to keep things simple just use
1075 * 2 * max_req * max_seg.
1077 #define MAX_GRANTS(max_req, max_seg) (2 * (max_req) * (max_seg))
1079 static int blk_connect(struct XenDevice
*xendev
)
1081 struct XenBlkDev
*blkdev
= container_of(xendev
, struct XenBlkDev
, xendev
);
1082 int pers
, index
, qflags
;
1083 bool readonly
= true;
1084 bool writethrough
= true;
1085 int order
, ring_ref
;
1086 unsigned int ring_size
, max_grants
;
1090 trace_xen_disk_connect(xendev
->name
);
1093 if (blkdev
->directiosafe
) {
1094 qflags
= BDRV_O_NOCACHE
| BDRV_O_NATIVE_AIO
;
1097 writethrough
= false;
1099 if (strcmp(blkdev
->mode
, "w") == 0) {
1100 qflags
|= BDRV_O_RDWR
;
1103 if (blkdev
->feature_discard
) {
1104 qflags
|= BDRV_O_UNMAP
;
1107 /* init qemu block driver */
1108 index
= (blkdev
->xendev
.dev
- 202 * 256) / 16;
1109 blkdev
->dinfo
= drive_get(IF_XEN
, 0, index
);
1110 if (!blkdev
->dinfo
) {
1111 Error
*local_err
= NULL
;
1112 QDict
*options
= NULL
;
1114 if (strcmp(blkdev
->fileproto
, "<unset>")) {
1115 options
= qdict_new();
1116 qdict_put_str(options
, "driver", blkdev
->fileproto
);
1119 /* setup via xenbus -> create new block driver instance */
1120 xen_pv_printf(&blkdev
->xendev
, 2, "create new bdrv (xenbus setup)\n");
1121 blkdev
->blk
= blk_new_open(blkdev
->filename
, NULL
, options
,
1122 qflags
, &local_err
);
1124 xen_pv_printf(&blkdev
->xendev
, 0, "error: %s\n",
1125 error_get_pretty(local_err
));
1126 error_free(local_err
);
1129 blk_set_enable_write_cache(blkdev
->blk
, !writethrough
);
1131 /* setup via qemu cmdline -> already setup for us */
1132 xen_pv_printf(&blkdev
->xendev
, 2,
1133 "get configured bdrv (cmdline setup)\n");
1134 blkdev
->blk
= blk_by_legacy_dinfo(blkdev
->dinfo
);
1135 if (blk_is_read_only(blkdev
->blk
) && !readonly
) {
1136 xen_pv_printf(&blkdev
->xendev
, 0, "Unexpected read-only drive");
1140 /* blkdev->blk is not create by us, we get a reference
1141 * so we can blk_unref() unconditionally */
1142 blk_ref(blkdev
->blk
);
1144 blk_attach_dev_legacy(blkdev
->blk
, blkdev
);
1145 blkdev
->file_size
= blk_getlength(blkdev
->blk
);
1146 if (blkdev
->file_size
< 0) {
1147 BlockDriverState
*bs
= blk_bs(blkdev
->blk
);
1148 const char *drv_name
= bs
? bdrv_get_format_name(bs
) : NULL
;
1149 xen_pv_printf(&blkdev
->xendev
, 1, "blk_getlength: %d (%s) | drv %s\n",
1150 (int)blkdev
->file_size
, strerror(-blkdev
->file_size
),
1152 blkdev
->file_size
= 0;
1155 xen_pv_printf(xendev
, 1, "type \"%s\", fileproto \"%s\", filename \"%s\","
1156 " size %" PRId64
" (%" PRId64
" MB)\n",
1157 blkdev
->type
, blkdev
->fileproto
, blkdev
->filename
,
1158 blkdev
->file_size
, blkdev
->file_size
>> 20);
1160 /* Fill in number of sector size and number of sectors */
1161 xenstore_write_be_int(&blkdev
->xendev
, "sector-size", blkdev
->file_blk
);
1162 xenstore_write_be_int64(&blkdev
->xendev
, "sectors",
1163 blkdev
->file_size
/ blkdev
->file_blk
);
1165 if (xenstore_read_fe_int(&blkdev
->xendev
, "ring-page-order",
1167 blkdev
->nr_ring_ref
= 1;
1169 if (xenstore_read_fe_int(&blkdev
->xendev
, "ring-ref",
1173 blkdev
->ring_ref
[0] = ring_ref
;
1175 } else if (order
>= 0 && order
<= MAX_RING_PAGE_ORDER
) {
1176 blkdev
->nr_ring_ref
= 1 << order
;
1178 for (i
= 0; i
< blkdev
->nr_ring_ref
; i
++) {
1181 key
= g_strdup_printf("ring-ref%u", i
);
1186 if (xenstore_read_fe_int(&blkdev
->xendev
, key
,
1191 blkdev
->ring_ref
[i
] = ring_ref
;
1196 xen_pv_printf(xendev
, 0, "invalid ring-page-order: %d\n",
1201 if (xenstore_read_fe_int(&blkdev
->xendev
, "event-channel",
1202 &blkdev
->xendev
.remote_port
) == -1) {
1205 if (xenstore_read_fe_int(&blkdev
->xendev
, "feature-persistent", &pers
)) {
1206 blkdev
->feature_persistent
= FALSE
;
1208 blkdev
->feature_persistent
= !!pers
;
1211 if (!blkdev
->xendev
.protocol
) {
1212 blkdev
->protocol
= BLKIF_PROTOCOL_NATIVE
;
1213 } else if (strcmp(blkdev
->xendev
.protocol
, XEN_IO_PROTO_ABI_NATIVE
) == 0) {
1214 blkdev
->protocol
= BLKIF_PROTOCOL_NATIVE
;
1215 } else if (strcmp(blkdev
->xendev
.protocol
, XEN_IO_PROTO_ABI_X86_32
) == 0) {
1216 blkdev
->protocol
= BLKIF_PROTOCOL_X86_32
;
1217 } else if (strcmp(blkdev
->xendev
.protocol
, XEN_IO_PROTO_ABI_X86_64
) == 0) {
1218 blkdev
->protocol
= BLKIF_PROTOCOL_X86_64
;
1220 blkdev
->protocol
= BLKIF_PROTOCOL_NATIVE
;
1223 ring_size
= XC_PAGE_SIZE
* blkdev
->nr_ring_ref
;
1224 switch (blkdev
->protocol
) {
1225 case BLKIF_PROTOCOL_NATIVE
:
1227 blkdev
->max_requests
= __CONST_RING_SIZE(blkif
, ring_size
);
1230 case BLKIF_PROTOCOL_X86_32
:
1232 blkdev
->max_requests
= __CONST_RING_SIZE(blkif_x86_32
, ring_size
);
1235 case BLKIF_PROTOCOL_X86_64
:
1237 blkdev
->max_requests
= __CONST_RING_SIZE(blkif_x86_64
, ring_size
);
1244 /* Calculate the maximum number of grants needed by ioreqs */
1245 max_grants
= MAX_GRANTS(blkdev
->max_requests
,
1246 BLKIF_MAX_SEGMENTS_PER_REQUEST
);
1247 /* Add on the number needed for the ring pages */
1248 max_grants
+= blkdev
->nr_ring_ref
;
1250 blkdev
->xendev
.gnttabdev
= xengnttab_open(NULL
, 0);
1251 if (blkdev
->xendev
.gnttabdev
== NULL
) {
1252 xen_pv_printf(xendev
, 0, "xengnttab_open failed: %s\n",
1256 if (xengnttab_set_max_grants(blkdev
->xendev
.gnttabdev
, max_grants
)) {
1257 xen_pv_printf(xendev
, 0, "xengnttab_set_max_grants failed: %s\n",
1262 domids
= g_new0(uint32_t, blkdev
->nr_ring_ref
);
1263 for (i
= 0; i
< blkdev
->nr_ring_ref
; i
++) {
1264 domids
[i
] = blkdev
->xendev
.dom
;
1267 blkdev
->sring
= xengnttab_map_grant_refs(blkdev
->xendev
.gnttabdev
,
1268 blkdev
->nr_ring_ref
,
1271 PROT_READ
| PROT_WRITE
);
1275 if (!blkdev
->sring
) {
1281 switch (blkdev
->protocol
) {
1282 case BLKIF_PROTOCOL_NATIVE
:
1284 blkif_sring_t
*sring_native
= blkdev
->sring
;
1285 BACK_RING_INIT(&blkdev
->rings
.native
, sring_native
, ring_size
);
1288 case BLKIF_PROTOCOL_X86_32
:
1290 blkif_x86_32_sring_t
*sring_x86_32
= blkdev
->sring
;
1292 BACK_RING_INIT(&blkdev
->rings
.x86_32_part
, sring_x86_32
, ring_size
);
1295 case BLKIF_PROTOCOL_X86_64
:
1297 blkif_x86_64_sring_t
*sring_x86_64
= blkdev
->sring
;
1299 BACK_RING_INIT(&blkdev
->rings
.x86_64_part
, sring_x86_64
, ring_size
);
1304 if (blkdev
->feature_persistent
) {
1305 /* Init persistent grants */
1306 blkdev
->max_grants
= blkdev
->max_requests
*
1307 BLKIF_MAX_SEGMENTS_PER_REQUEST
;
1308 blkdev
->persistent_gnts
= g_tree_new_full((GCompareDataFunc
)int_cmp
,
1311 (GDestroyNotify
)g_free
:
1312 (GDestroyNotify
)destroy_grant
);
1313 blkdev
->persistent_regions
= NULL
;
1314 blkdev
->persistent_gnt_count
= 0;
1317 blk_set_aio_context(blkdev
->blk
, blkdev
->ctx
);
1319 xen_be_bind_evtchn(&blkdev
->xendev
);
1321 xen_pv_printf(&blkdev
->xendev
, 1, "ok: proto %s, nr-ring-ref %u, "
1322 "remote port %d, local port %d\n",
1323 blkdev
->xendev
.protocol
, blkdev
->nr_ring_ref
,
1324 blkdev
->xendev
.remote_port
, blkdev
->xendev
.local_port
);
1328 static void blk_disconnect(struct XenDevice
*xendev
)
1330 struct XenBlkDev
*blkdev
= container_of(xendev
, struct XenBlkDev
, xendev
);
1332 trace_xen_disk_disconnect(xendev
->name
);
1334 aio_context_acquire(blkdev
->ctx
);
1337 blk_set_aio_context(blkdev
->blk
, qemu_get_aio_context());
1338 blk_detach_dev(blkdev
->blk
, blkdev
);
1339 blk_unref(blkdev
->blk
);
1342 xen_pv_unbind_evtchn(&blkdev
->xendev
);
1344 aio_context_release(blkdev
->ctx
);
1346 if (blkdev
->sring
) {
1347 xengnttab_unmap(blkdev
->xendev
.gnttabdev
, blkdev
->sring
,
1348 blkdev
->nr_ring_ref
);
1350 blkdev
->sring
= NULL
;
1354 * Unmap persistent grants before switching to the closed state
1355 * so the frontend can free them.
1357 * In the !batch_maps case g_tree_destroy will take care of unmapping
1358 * the grant, but in the batch_maps case we need to iterate over every
1359 * region in persistent_regions and unmap it.
1361 if (blkdev
->feature_persistent
) {
1362 g_tree_destroy(blkdev
->persistent_gnts
);
1363 assert(batch_maps
|| blkdev
->persistent_gnt_count
== 0);
1365 blkdev
->persistent_gnt_count
= 0;
1366 g_slist_foreach(blkdev
->persistent_regions
,
1367 (GFunc
)remove_persistent_region
, blkdev
);
1368 g_slist_free(blkdev
->persistent_regions
);
1370 blkdev
->feature_persistent
= false;
1373 if (blkdev
->xendev
.gnttabdev
) {
1374 xengnttab_close(blkdev
->xendev
.gnttabdev
);
1375 blkdev
->xendev
.gnttabdev
= NULL
;
1379 static int blk_free(struct XenDevice
*xendev
)
1381 struct XenBlkDev
*blkdev
= container_of(xendev
, struct XenBlkDev
, xendev
);
1382 struct ioreq
*ioreq
;
1384 trace_xen_disk_free(xendev
->name
);
1386 blk_disconnect(xendev
);
1388 while (!QLIST_EMPTY(&blkdev
->freelist
)) {
1389 ioreq
= QLIST_FIRST(&blkdev
->freelist
);
1390 QLIST_REMOVE(ioreq
, list
);
1391 qemu_iovec_destroy(&ioreq
->v
);
1395 g_free(blkdev
->params
);
1396 g_free(blkdev
->mode
);
1397 g_free(blkdev
->type
);
1398 g_free(blkdev
->dev
);
1399 g_free(blkdev
->devtype
);
1400 qemu_bh_delete(blkdev
->bh
);
1401 iothread_destroy(blkdev
->iothread
);
1405 static void blk_event(struct XenDevice
*xendev
)
1407 struct XenBlkDev
*blkdev
= container_of(xendev
, struct XenBlkDev
, xendev
);
1409 qemu_bh_schedule(blkdev
->bh
);
1412 struct XenDevOps xen_blkdev_ops
= {
1413 .size
= sizeof(struct XenBlkDev
),
1416 .initialise
= blk_connect
,
1417 .disconnect
= blk_disconnect
,