2 * GlusterFS backend for QEMU
4 * Copyright (C) 2012 Bharata B Rao <bharata@linux.vnet.ibm.com>
6 * This work is licensed under the terms of the GNU GPL, version 2 or later.
7 * See the COPYING file in the top-level directory.
10 #include <glusterfs/api/glfs.h>
11 #include "block/block_int.h"
14 typedef struct GlusterAIOCB
{
19 AioContext
*aio_context
;
22 typedef struct BDRVGlusterState
{
27 typedef struct GlusterConf
{
35 static void qemu_gluster_gconf_free(GlusterConf
*gconf
)
38 g_free(gconf
->server
);
39 g_free(gconf
->volname
);
41 g_free(gconf
->transport
);
46 static int parse_volume_options(GlusterConf
*gconf
, char *path
)
55 p
= q
= path
+ strspn(path
, "/");
60 gconf
->volname
= g_strndup(q
, p
- q
);
67 gconf
->image
= g_strdup(p
);
72 * file=gluster[+transport]://[server[:port]]/volname/image[?socket=...]
74 * 'gluster' is the protocol.
76 * 'transport' specifies the transport type used to connect to gluster
77 * management daemon (glusterd). Valid transport types are
78 * tcp, unix and rdma. If a transport type isn't specified, then tcp
81 * 'server' specifies the server where the volume file specification for
82 * the given volume resides. This can be either hostname, ipv4 address
83 * or ipv6 address. ipv6 address needs to be within square brackets [ ].
84 * If transport type is 'unix', then 'server' field should not be specified.
85 * The 'socket' field needs to be populated with the path to unix domain
88 * 'port' is the port number on which glusterd is listening. This is optional
89 * and if not specified, QEMU will send 0 which will make gluster to use the
90 * default port. If the transport type is unix, then 'port' should not be
93 * 'volname' is the name of the gluster volume which contains the VM image.
95 * 'image' is the path to the actual VM image that resides on gluster volume.
99 * file=gluster://1.2.3.4/testvol/a.img
100 * file=gluster+tcp://1.2.3.4/testvol/a.img
101 * file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
102 * file=gluster+tcp://[1:2:3:4:5:6:7:8]/testvol/dir/a.img
103 * file=gluster+tcp://[1:2:3:4:5:6:7:8]:24007/testvol/dir/a.img
104 * file=gluster+tcp://server.domain.com:24007/testvol/dir/a.img
105 * file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
106 * file=gluster+rdma://1.2.3.4:24007/testvol/a.img
108 static int qemu_gluster_parseuri(GlusterConf
*gconf
, const char *filename
)
111 QueryParams
*qp
= NULL
;
112 bool is_unix
= false;
115 uri
= uri_parse(filename
);
121 if (!uri
->scheme
|| !strcmp(uri
->scheme
, "gluster")) {
122 gconf
->transport
= g_strdup("tcp");
123 } else if (!strcmp(uri
->scheme
, "gluster+tcp")) {
124 gconf
->transport
= g_strdup("tcp");
125 } else if (!strcmp(uri
->scheme
, "gluster+unix")) {
126 gconf
->transport
= g_strdup("unix");
128 } else if (!strcmp(uri
->scheme
, "gluster+rdma")) {
129 gconf
->transport
= g_strdup("rdma");
135 ret
= parse_volume_options(gconf
, uri
->path
);
140 qp
= query_params_parse(uri
->query
);
141 if (qp
->n
> 1 || (is_unix
&& !qp
->n
) || (!is_unix
&& qp
->n
)) {
147 if (uri
->server
|| uri
->port
) {
151 if (strcmp(qp
->p
[0].name
, "socket")) {
155 gconf
->server
= g_strdup(qp
->p
[0].value
);
157 gconf
->server
= g_strdup(uri
->server
? uri
->server
: "localhost");
158 gconf
->port
= uri
->port
;
163 query_params_free(qp
);
169 static struct glfs
*qemu_gluster_init(GlusterConf
*gconf
, const char *filename
,
172 struct glfs
*glfs
= NULL
;
176 ret
= qemu_gluster_parseuri(gconf
, filename
);
178 error_setg(errp
, "Usage: file=gluster[+transport]://[server[:port]]/"
179 "volname/image[?socket=...]");
184 glfs
= glfs_new(gconf
->volname
);
189 ret
= glfs_set_volfile_server(glfs
, gconf
->transport
, gconf
->server
,
196 * TODO: Use GF_LOG_ERROR instead of hard code value of 4 here when
197 * GlusterFS makes GF_LOG_* macros available to libgfapi users.
199 ret
= glfs_set_logging(glfs
, "-", 4);
204 ret
= glfs_init(glfs
);
206 error_setg_errno(errp
, errno
,
207 "Gluster connection failed for server=%s port=%d "
208 "volume=%s image=%s transport=%s", gconf
->server
,
209 gconf
->port
, gconf
->volname
, gconf
->image
,
212 /* glfs_init sometimes doesn't set errno although docs suggest that */
229 static void qemu_gluster_complete_aio(void *opaque
)
231 GlusterAIOCB
*acb
= (GlusterAIOCB
*)opaque
;
233 qemu_bh_delete(acb
->bh
);
235 qemu_coroutine_enter(acb
->coroutine
, NULL
);
239 * AIO callback routine called from GlusterFS thread.
241 static void gluster_finish_aiocb(struct glfs_fd
*fd
, ssize_t ret
, void *arg
)
243 GlusterAIOCB
*acb
= (GlusterAIOCB
*)arg
;
245 if (!ret
|| ret
== acb
->size
) {
246 acb
->ret
= 0; /* Success */
247 } else if (ret
< 0) {
248 acb
->ret
= ret
; /* Read/Write failed */
250 acb
->ret
= -EIO
; /* Partial read/write - fail it */
253 acb
->bh
= aio_bh_new(acb
->aio_context
, qemu_gluster_complete_aio
, acb
);
254 qemu_bh_schedule(acb
->bh
);
257 /* TODO Convert to fine grained options */
258 static QemuOptsList runtime_opts
= {
260 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
264 .type
= QEMU_OPT_STRING
,
265 .help
= "URL to the gluster image",
267 { /* end of list */ }
271 static void qemu_gluster_parse_flags(int bdrv_flags
, int *open_flags
)
273 assert(open_flags
!= NULL
);
275 *open_flags
|= O_BINARY
;
277 if (bdrv_flags
& BDRV_O_RDWR
) {
278 *open_flags
|= O_RDWR
;
280 *open_flags
|= O_RDONLY
;
283 if ((bdrv_flags
& BDRV_O_NOCACHE
)) {
284 *open_flags
|= O_DIRECT
;
288 static int qemu_gluster_open(BlockDriverState
*bs
, QDict
*options
,
289 int bdrv_flags
, Error
**errp
)
291 BDRVGlusterState
*s
= bs
->opaque
;
294 GlusterConf
*gconf
= g_malloc0(sizeof(GlusterConf
));
296 Error
*local_err
= NULL
;
297 const char *filename
;
299 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
300 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
302 error_propagate(errp
, local_err
);
307 filename
= qemu_opt_get(opts
, "filename");
309 s
->glfs
= qemu_gluster_init(gconf
, filename
, errp
);
315 qemu_gluster_parse_flags(bdrv_flags
, &open_flags
);
317 s
->fd
= glfs_open(s
->glfs
, gconf
->image
, open_flags
);
324 qemu_gluster_gconf_free(gconf
);
337 typedef struct BDRVGlusterReopenState
{
340 } BDRVGlusterReopenState
;
343 static int qemu_gluster_reopen_prepare(BDRVReopenState
*state
,
344 BlockReopenQueue
*queue
, Error
**errp
)
347 BDRVGlusterReopenState
*reop_s
;
348 GlusterConf
*gconf
= NULL
;
351 assert(state
!= NULL
);
352 assert(state
->bs
!= NULL
);
354 state
->opaque
= g_malloc0(sizeof(BDRVGlusterReopenState
));
355 reop_s
= state
->opaque
;
357 qemu_gluster_parse_flags(state
->flags
, &open_flags
);
359 gconf
= g_malloc0(sizeof(GlusterConf
));
361 reop_s
->glfs
= qemu_gluster_init(gconf
, state
->bs
->filename
, errp
);
362 if (reop_s
->glfs
== NULL
) {
367 reop_s
->fd
= glfs_open(reop_s
->glfs
, gconf
->image
, open_flags
);
368 if (reop_s
->fd
== NULL
) {
369 /* reops->glfs will be cleaned up in _abort */
375 /* state->opaque will be freed in either the _abort or _commit */
376 qemu_gluster_gconf_free(gconf
);
380 static void qemu_gluster_reopen_commit(BDRVReopenState
*state
)
382 BDRVGlusterReopenState
*reop_s
= state
->opaque
;
383 BDRVGlusterState
*s
= state
->bs
->opaque
;
394 /* use the newly opened image / connection */
396 s
->glfs
= reop_s
->glfs
;
398 g_free(state
->opaque
);
399 state
->opaque
= NULL
;
405 static void qemu_gluster_reopen_abort(BDRVReopenState
*state
)
407 BDRVGlusterReopenState
*reop_s
= state
->opaque
;
409 if (reop_s
== NULL
) {
414 glfs_close(reop_s
->fd
);
418 glfs_fini(reop_s
->glfs
);
421 g_free(state
->opaque
);
422 state
->opaque
= NULL
;
427 #ifdef CONFIG_GLUSTERFS_ZEROFILL
428 static coroutine_fn
int qemu_gluster_co_write_zeroes(BlockDriverState
*bs
,
429 int64_t sector_num
, int nb_sectors
, BdrvRequestFlags flags
)
432 GlusterAIOCB
*acb
= g_slice_new(GlusterAIOCB
);
433 BDRVGlusterState
*s
= bs
->opaque
;
434 off_t size
= nb_sectors
* BDRV_SECTOR_SIZE
;
435 off_t offset
= sector_num
* BDRV_SECTOR_SIZE
;
439 acb
->coroutine
= qemu_coroutine_self();
440 acb
->aio_context
= bdrv_get_aio_context(bs
);
442 ret
= glfs_zerofill_async(s
->fd
, offset
, size
, &gluster_finish_aiocb
, acb
);
448 qemu_coroutine_yield();
452 g_slice_free(GlusterAIOCB
, acb
);
456 static inline bool gluster_supports_zerofill(void)
461 static inline int qemu_gluster_zerofill(struct glfs_fd
*fd
, int64_t offset
,
464 return glfs_zerofill(fd
, offset
, size
);
468 static inline bool gluster_supports_zerofill(void)
473 static inline int qemu_gluster_zerofill(struct glfs_fd
*fd
, int64_t offset
,
480 static int qemu_gluster_create(const char *filename
,
481 QEMUOptionParameter
*options
, Error
**errp
)
487 int64_t total_size
= 0;
488 GlusterConf
*gconf
= g_malloc0(sizeof(GlusterConf
));
490 glfs
= qemu_gluster_init(gconf
, filename
, errp
);
496 while (options
&& options
->name
) {
497 if (!strcmp(options
->name
, BLOCK_OPT_SIZE
)) {
498 total_size
= options
->value
.n
/ BDRV_SECTOR_SIZE
;
499 } else if (!strcmp(options
->name
, BLOCK_OPT_PREALLOC
)) {
500 if (!options
->value
.s
|| !strcmp(options
->value
.s
, "off")) {
502 } else if (!strcmp(options
->value
.s
, "full") &&
503 gluster_supports_zerofill()) {
506 error_setg(errp
, "Invalid preallocation mode: '%s'"
507 " or GlusterFS doesn't support zerofill API",
516 fd
= glfs_creat(glfs
, gconf
->image
,
517 O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
, S_IRUSR
| S_IWUSR
);
521 if (!glfs_ftruncate(fd
, total_size
* BDRV_SECTOR_SIZE
)) {
522 if (prealloc
&& qemu_gluster_zerofill(fd
, 0,
523 total_size
* BDRV_SECTOR_SIZE
)) {
530 if (glfs_close(fd
) != 0) {
535 qemu_gluster_gconf_free(gconf
);
542 static coroutine_fn
int qemu_gluster_co_rw(BlockDriverState
*bs
,
543 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
, int write
)
546 GlusterAIOCB
*acb
= g_slice_new(GlusterAIOCB
);
547 BDRVGlusterState
*s
= bs
->opaque
;
548 size_t size
= nb_sectors
* BDRV_SECTOR_SIZE
;
549 off_t offset
= sector_num
* BDRV_SECTOR_SIZE
;
553 acb
->coroutine
= qemu_coroutine_self();
554 acb
->aio_context
= bdrv_get_aio_context(bs
);
557 ret
= glfs_pwritev_async(s
->fd
, qiov
->iov
, qiov
->niov
, offset
, 0,
558 &gluster_finish_aiocb
, acb
);
560 ret
= glfs_preadv_async(s
->fd
, qiov
->iov
, qiov
->niov
, offset
, 0,
561 &gluster_finish_aiocb
, acb
);
569 qemu_coroutine_yield();
573 g_slice_free(GlusterAIOCB
, acb
);
577 static int qemu_gluster_truncate(BlockDriverState
*bs
, int64_t offset
)
580 BDRVGlusterState
*s
= bs
->opaque
;
582 ret
= glfs_ftruncate(s
->fd
, offset
);
590 static coroutine_fn
int qemu_gluster_co_readv(BlockDriverState
*bs
,
591 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
)
593 return qemu_gluster_co_rw(bs
, sector_num
, nb_sectors
, qiov
, 0);
596 static coroutine_fn
int qemu_gluster_co_writev(BlockDriverState
*bs
,
597 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
)
599 return qemu_gluster_co_rw(bs
, sector_num
, nb_sectors
, qiov
, 1);
602 static coroutine_fn
int qemu_gluster_co_flush_to_disk(BlockDriverState
*bs
)
605 GlusterAIOCB
*acb
= g_slice_new(GlusterAIOCB
);
606 BDRVGlusterState
*s
= bs
->opaque
;
610 acb
->coroutine
= qemu_coroutine_self();
611 acb
->aio_context
= bdrv_get_aio_context(bs
);
613 ret
= glfs_fsync_async(s
->fd
, &gluster_finish_aiocb
, acb
);
619 qemu_coroutine_yield();
623 g_slice_free(GlusterAIOCB
, acb
);
627 #ifdef CONFIG_GLUSTERFS_DISCARD
628 static coroutine_fn
int qemu_gluster_co_discard(BlockDriverState
*bs
,
629 int64_t sector_num
, int nb_sectors
)
632 GlusterAIOCB
*acb
= g_slice_new(GlusterAIOCB
);
633 BDRVGlusterState
*s
= bs
->opaque
;
634 size_t size
= nb_sectors
* BDRV_SECTOR_SIZE
;
635 off_t offset
= sector_num
* BDRV_SECTOR_SIZE
;
639 acb
->coroutine
= qemu_coroutine_self();
640 acb
->aio_context
= bdrv_get_aio_context(bs
);
642 ret
= glfs_discard_async(s
->fd
, offset
, size
, &gluster_finish_aiocb
, acb
);
648 qemu_coroutine_yield();
652 g_slice_free(GlusterAIOCB
, acb
);
657 static int64_t qemu_gluster_getlength(BlockDriverState
*bs
)
659 BDRVGlusterState
*s
= bs
->opaque
;
662 ret
= glfs_lseek(s
->fd
, 0, SEEK_END
);
670 static int64_t qemu_gluster_allocated_file_size(BlockDriverState
*bs
)
672 BDRVGlusterState
*s
= bs
->opaque
;
676 ret
= glfs_fstat(s
->fd
, &st
);
680 return st
.st_blocks
* 512;
684 static void qemu_gluster_close(BlockDriverState
*bs
)
686 BDRVGlusterState
*s
= bs
->opaque
;
695 static int qemu_gluster_has_zero_init(BlockDriverState
*bs
)
697 /* GlusterFS volume could be backed by a block device */
701 static QEMUOptionParameter qemu_gluster_create_options
[] = {
703 .name
= BLOCK_OPT_SIZE
,
705 .help
= "Virtual disk size"
708 .name
= BLOCK_OPT_PREALLOC
,
710 .help
= "Preallocation mode (allowed values: off, full)"
715 static BlockDriver bdrv_gluster
= {
716 .format_name
= "gluster",
717 .protocol_name
= "gluster",
718 .instance_size
= sizeof(BDRVGlusterState
),
719 .bdrv_needs_filename
= true,
720 .bdrv_file_open
= qemu_gluster_open
,
721 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
722 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
723 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
724 .bdrv_close
= qemu_gluster_close
,
725 .bdrv_create
= qemu_gluster_create
,
726 .bdrv_getlength
= qemu_gluster_getlength
,
727 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
728 .bdrv_truncate
= qemu_gluster_truncate
,
729 .bdrv_co_readv
= qemu_gluster_co_readv
,
730 .bdrv_co_writev
= qemu_gluster_co_writev
,
731 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
732 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
733 #ifdef CONFIG_GLUSTERFS_DISCARD
734 .bdrv_co_discard
= qemu_gluster_co_discard
,
736 #ifdef CONFIG_GLUSTERFS_ZEROFILL
737 .bdrv_co_write_zeroes
= qemu_gluster_co_write_zeroes
,
739 .create_options
= qemu_gluster_create_options
,
742 static BlockDriver bdrv_gluster_tcp
= {
743 .format_name
= "gluster",
744 .protocol_name
= "gluster+tcp",
745 .instance_size
= sizeof(BDRVGlusterState
),
746 .bdrv_needs_filename
= true,
747 .bdrv_file_open
= qemu_gluster_open
,
748 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
749 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
750 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
751 .bdrv_close
= qemu_gluster_close
,
752 .bdrv_create
= qemu_gluster_create
,
753 .bdrv_getlength
= qemu_gluster_getlength
,
754 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
755 .bdrv_truncate
= qemu_gluster_truncate
,
756 .bdrv_co_readv
= qemu_gluster_co_readv
,
757 .bdrv_co_writev
= qemu_gluster_co_writev
,
758 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
759 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
760 #ifdef CONFIG_GLUSTERFS_DISCARD
761 .bdrv_co_discard
= qemu_gluster_co_discard
,
763 #ifdef CONFIG_GLUSTERFS_ZEROFILL
764 .bdrv_co_write_zeroes
= qemu_gluster_co_write_zeroes
,
766 .create_options
= qemu_gluster_create_options
,
769 static BlockDriver bdrv_gluster_unix
= {
770 .format_name
= "gluster",
771 .protocol_name
= "gluster+unix",
772 .instance_size
= sizeof(BDRVGlusterState
),
773 .bdrv_needs_filename
= true,
774 .bdrv_file_open
= qemu_gluster_open
,
775 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
776 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
777 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
778 .bdrv_close
= qemu_gluster_close
,
779 .bdrv_create
= qemu_gluster_create
,
780 .bdrv_getlength
= qemu_gluster_getlength
,
781 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
782 .bdrv_truncate
= qemu_gluster_truncate
,
783 .bdrv_co_readv
= qemu_gluster_co_readv
,
784 .bdrv_co_writev
= qemu_gluster_co_writev
,
785 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
786 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
787 #ifdef CONFIG_GLUSTERFS_DISCARD
788 .bdrv_co_discard
= qemu_gluster_co_discard
,
790 #ifdef CONFIG_GLUSTERFS_ZEROFILL
791 .bdrv_co_write_zeroes
= qemu_gluster_co_write_zeroes
,
793 .create_options
= qemu_gluster_create_options
,
796 static BlockDriver bdrv_gluster_rdma
= {
797 .format_name
= "gluster",
798 .protocol_name
= "gluster+rdma",
799 .instance_size
= sizeof(BDRVGlusterState
),
800 .bdrv_needs_filename
= true,
801 .bdrv_file_open
= qemu_gluster_open
,
802 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
803 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
804 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
805 .bdrv_close
= qemu_gluster_close
,
806 .bdrv_create
= qemu_gluster_create
,
807 .bdrv_getlength
= qemu_gluster_getlength
,
808 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
809 .bdrv_truncate
= qemu_gluster_truncate
,
810 .bdrv_co_readv
= qemu_gluster_co_readv
,
811 .bdrv_co_writev
= qemu_gluster_co_writev
,
812 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
813 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
814 #ifdef CONFIG_GLUSTERFS_DISCARD
815 .bdrv_co_discard
= qemu_gluster_co_discard
,
817 #ifdef CONFIG_GLUSTERFS_ZEROFILL
818 .bdrv_co_write_zeroes
= qemu_gluster_co_write_zeroes
,
820 .create_options
= qemu_gluster_create_options
,
823 static void bdrv_gluster_init(void)
825 bdrv_register(&bdrv_gluster_rdma
);
826 bdrv_register(&bdrv_gluster_unix
);
827 bdrv_register(&bdrv_gluster_tcp
);
828 bdrv_register(&bdrv_gluster
);
831 block_init(bdrv_gluster_init
);