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.
11 #include "qemu/osdep.h"
12 #include <glusterfs/api/glfs.h>
13 #include "block/block_int.h"
14 #include "qapi/error.h"
15 #include "qapi/qmp/qdict.h"
16 #include "qapi/qmp/qerror.h"
18 #include "qemu/error-report.h"
19 #include "qemu/option.h"
20 #include "qemu/cutils.h"
22 #define GLUSTER_OPT_FILENAME "filename"
23 #define GLUSTER_OPT_VOLUME "volume"
24 #define GLUSTER_OPT_PATH "path"
25 #define GLUSTER_OPT_TYPE "type"
26 #define GLUSTER_OPT_SERVER_PATTERN "server."
27 #define GLUSTER_OPT_HOST "host"
28 #define GLUSTER_OPT_PORT "port"
29 #define GLUSTER_OPT_TO "to"
30 #define GLUSTER_OPT_IPV4 "ipv4"
31 #define GLUSTER_OPT_IPV6 "ipv6"
32 #define GLUSTER_OPT_SOCKET "socket"
33 #define GLUSTER_OPT_DEBUG "debug"
34 #define GLUSTER_DEFAULT_PORT 24007
35 #define GLUSTER_DEBUG_DEFAULT 4
36 #define GLUSTER_DEBUG_MAX 9
37 #define GLUSTER_OPT_LOGFILE "logfile"
38 #define GLUSTER_LOGFILE_DEFAULT "-" /* handled in libgfapi as /dev/stderr */
40 #define GERR_INDEX_HINT "hint: check in 'server' array index '%d'\n"
42 typedef struct GlusterAIOCB
{
46 AioContext
*aio_context
;
49 typedef struct BDRVGlusterState
{
53 bool supports_seek_data
;
57 typedef struct BDRVGlusterReopenState
{
60 } BDRVGlusterReopenState
;
63 typedef struct GlfsPreopened
{
69 typedef struct ListElement
{
70 QLIST_ENTRY(ListElement
) list
;
74 static QLIST_HEAD(glfs_list
, ListElement
) glfs_list
;
76 static QemuOptsList qemu_gluster_create_opts
= {
77 .name
= "qemu-gluster-create-opts",
78 .head
= QTAILQ_HEAD_INITIALIZER(qemu_gluster_create_opts
.head
),
81 .name
= BLOCK_OPT_SIZE
,
82 .type
= QEMU_OPT_SIZE
,
83 .help
= "Virtual disk size"
86 .name
= BLOCK_OPT_PREALLOC
,
87 .type
= QEMU_OPT_STRING
,
88 .help
= "Preallocation mode (allowed values: off, full)"
91 .name
= GLUSTER_OPT_DEBUG
,
92 .type
= QEMU_OPT_NUMBER
,
93 .help
= "Gluster log level, valid range is 0-9",
96 .name
= GLUSTER_OPT_LOGFILE
,
97 .type
= QEMU_OPT_STRING
,
98 .help
= "Logfile path of libgfapi",
100 { /* end of list */ }
104 static QemuOptsList runtime_opts
= {
106 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
109 .name
= GLUSTER_OPT_FILENAME
,
110 .type
= QEMU_OPT_STRING
,
111 .help
= "URL to the gluster image",
114 .name
= GLUSTER_OPT_DEBUG
,
115 .type
= QEMU_OPT_NUMBER
,
116 .help
= "Gluster log level, valid range is 0-9",
119 .name
= GLUSTER_OPT_LOGFILE
,
120 .type
= QEMU_OPT_STRING
,
121 .help
= "Logfile path of libgfapi",
123 { /* end of list */ }
127 static QemuOptsList runtime_json_opts
= {
128 .name
= "gluster_json",
129 .head
= QTAILQ_HEAD_INITIALIZER(runtime_json_opts
.head
),
132 .name
= GLUSTER_OPT_VOLUME
,
133 .type
= QEMU_OPT_STRING
,
134 .help
= "name of gluster volume where VM image resides",
137 .name
= GLUSTER_OPT_PATH
,
138 .type
= QEMU_OPT_STRING
,
139 .help
= "absolute path to image file in gluster volume",
142 .name
= GLUSTER_OPT_DEBUG
,
143 .type
= QEMU_OPT_NUMBER
,
144 .help
= "Gluster log level, valid range is 0-9",
146 { /* end of list */ }
150 static QemuOptsList runtime_type_opts
= {
151 .name
= "gluster_type",
152 .head
= QTAILQ_HEAD_INITIALIZER(runtime_type_opts
.head
),
155 .name
= GLUSTER_OPT_TYPE
,
156 .type
= QEMU_OPT_STRING
,
159 { /* end of list */ }
163 static QemuOptsList runtime_unix_opts
= {
164 .name
= "gluster_unix",
165 .head
= QTAILQ_HEAD_INITIALIZER(runtime_unix_opts
.head
),
168 .name
= GLUSTER_OPT_SOCKET
,
169 .type
= QEMU_OPT_STRING
,
170 .help
= "socket file path)",
172 { /* end of list */ }
176 static QemuOptsList runtime_inet_opts
= {
177 .name
= "gluster_inet",
178 .head
= QTAILQ_HEAD_INITIALIZER(runtime_inet_opts
.head
),
181 .name
= GLUSTER_OPT_TYPE
,
182 .type
= QEMU_OPT_STRING
,
186 .name
= GLUSTER_OPT_HOST
,
187 .type
= QEMU_OPT_STRING
,
188 .help
= "host address (hostname/ipv4/ipv6 addresses)",
191 .name
= GLUSTER_OPT_PORT
,
192 .type
= QEMU_OPT_STRING
,
193 .help
= "port number on which glusterd is listening (default 24007)",
197 .type
= QEMU_OPT_NUMBER
,
198 .help
= "max port number, not supported by gluster",
202 .type
= QEMU_OPT_BOOL
,
203 .help
= "ipv4 bool value, not supported by gluster",
207 .type
= QEMU_OPT_BOOL
,
208 .help
= "ipv6 bool value, not supported by gluster",
210 { /* end of list */ }
214 static void glfs_set_preopened(const char *volume
, glfs_t
*fs
)
216 ListElement
*entry
= NULL
;
218 entry
= g_new(ListElement
, 1);
220 entry
->saved
.volume
= g_strdup(volume
);
222 entry
->saved
.fs
= fs
;
223 entry
->saved
.ref
= 1;
225 QLIST_INSERT_HEAD(&glfs_list
, entry
, list
);
228 static glfs_t
*glfs_find_preopened(const char *volume
)
230 ListElement
*entry
= NULL
;
232 QLIST_FOREACH(entry
, &glfs_list
, list
) {
233 if (strcmp(entry
->saved
.volume
, volume
) == 0) {
235 return entry
->saved
.fs
;
242 static void glfs_clear_preopened(glfs_t
*fs
)
244 ListElement
*entry
= NULL
;
251 QLIST_FOREACH_SAFE(entry
, &glfs_list
, list
, next
) {
252 if (entry
->saved
.fs
== fs
) {
253 if (--entry
->saved
.ref
) {
257 QLIST_REMOVE(entry
, list
);
259 glfs_fini(entry
->saved
.fs
);
260 g_free(entry
->saved
.volume
);
266 static int parse_volume_options(BlockdevOptionsGluster
*gconf
, char *path
)
275 p
= q
= path
+ strspn(path
, "/");
276 p
+= strcspn(p
, "/");
280 gconf
->volume
= g_strndup(q
, p
- q
);
287 gconf
->path
= g_strdup(p
);
292 * file=gluster[+transport]://[host[:port]]/volume/path[?socket=...]
294 * 'gluster' is the protocol.
296 * 'transport' specifies the transport type used to connect to gluster
297 * management daemon (glusterd). Valid transport types are
298 * tcp or unix. If a transport type isn't specified, then tcp type is assumed.
300 * 'host' specifies the host where the volume file specification for
301 * the given volume resides. This can be either hostname or ipv4 address.
302 * If transport type is 'unix', then 'host' field should not be specified.
303 * The 'socket' field needs to be populated with the path to unix domain
306 * 'port' is the port number on which glusterd is listening. This is optional
307 * and if not specified, QEMU will send 0 which will make gluster to use the
308 * default port. If the transport type is unix, then 'port' should not be
311 * 'volume' is the name of the gluster volume which contains the VM image.
313 * 'path' is the path to the actual VM image that resides on gluster volume.
317 * file=gluster://1.2.3.4/testvol/a.img
318 * file=gluster+tcp://1.2.3.4/testvol/a.img
319 * file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
320 * file=gluster+tcp://host.domain.com:24007/testvol/dir/a.img
321 * file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
323 static int qemu_gluster_parse_uri(BlockdevOptionsGluster
*gconf
,
324 const char *filename
)
326 SocketAddress
*gsconf
;
328 QueryParams
*qp
= NULL
;
329 bool is_unix
= false;
332 uri
= uri_parse(filename
);
337 gconf
->server
= g_new0(SocketAddressList
, 1);
338 gconf
->server
->value
= gsconf
= g_new0(SocketAddress
, 1);
341 if (!uri
->scheme
|| !strcmp(uri
->scheme
, "gluster")) {
342 gsconf
->type
= SOCKET_ADDRESS_TYPE_INET
;
343 } else if (!strcmp(uri
->scheme
, "gluster+tcp")) {
344 gsconf
->type
= SOCKET_ADDRESS_TYPE_INET
;
345 } else if (!strcmp(uri
->scheme
, "gluster+unix")) {
346 gsconf
->type
= SOCKET_ADDRESS_TYPE_UNIX
;
348 } else if (!strcmp(uri
->scheme
, "gluster+rdma")) {
349 gsconf
->type
= SOCKET_ADDRESS_TYPE_INET
;
350 warn_report("rdma feature is not supported, falling back to tcp");
356 ret
= parse_volume_options(gconf
, uri
->path
);
361 qp
= query_params_parse(uri
->query
);
362 if (qp
->n
> 1 || (is_unix
&& !qp
->n
) || (!is_unix
&& qp
->n
)) {
368 if (uri
->server
|| uri
->port
) {
372 if (strcmp(qp
->p
[0].name
, "socket")) {
376 gsconf
->u
.q_unix
.path
= g_strdup(qp
->p
[0].value
);
378 gsconf
->u
.inet
.host
= g_strdup(uri
->server
? uri
->server
: "localhost");
380 gsconf
->u
.inet
.port
= g_strdup_printf("%d", uri
->port
);
382 gsconf
->u
.inet
.port
= g_strdup_printf("%d", GLUSTER_DEFAULT_PORT
);
388 query_params_free(qp
);
394 static struct glfs
*qemu_gluster_glfs_init(BlockdevOptionsGluster
*gconf
,
400 SocketAddressList
*server
;
401 unsigned long long port
;
403 glfs
= glfs_find_preopened(gconf
->volume
);
408 glfs
= glfs_new(gconf
->volume
);
413 glfs_set_preopened(gconf
->volume
, glfs
);
415 for (server
= gconf
->server
; server
; server
= server
->next
) {
416 switch (server
->value
->type
) {
417 case SOCKET_ADDRESS_TYPE_UNIX
:
418 ret
= glfs_set_volfile_server(glfs
, "unix",
419 server
->value
->u
.q_unix
.path
, 0);
421 case SOCKET_ADDRESS_TYPE_INET
:
422 if (parse_uint_full(server
->value
->u
.inet
.port
, &port
, 10) < 0 ||
424 error_setg(errp
, "'%s' is not a valid port number",
425 server
->value
->u
.inet
.port
);
429 ret
= glfs_set_volfile_server(glfs
, "tcp",
430 server
->value
->u
.inet
.host
,
433 case SOCKET_ADDRESS_TYPE_VSOCK
:
434 case SOCKET_ADDRESS_TYPE_FD
:
444 ret
= glfs_set_logging(glfs
, gconf
->logfile
, gconf
->debug
);
449 ret
= glfs_init(glfs
);
451 error_setg(errp
, "Gluster connection for volume %s, path %s failed"
452 " to connect", gconf
->volume
, gconf
->path
);
453 for (server
= gconf
->server
; server
; server
= server
->next
) {
454 if (server
->value
->type
== SOCKET_ADDRESS_TYPE_UNIX
) {
455 error_append_hint(errp
, "hint: failed on socket %s ",
456 server
->value
->u
.q_unix
.path
);
458 error_append_hint(errp
, "hint: failed on host %s and port %s ",
459 server
->value
->u
.inet
.host
,
460 server
->value
->u
.inet
.port
);
464 error_append_hint(errp
, "Please refer to gluster logs for more info\n");
466 /* glfs_init sometimes doesn't set errno although docs suggest that */
478 glfs_clear_preopened(glfs
);
485 * Convert the json formatted command line into qapi.
487 static int qemu_gluster_parse_json(BlockdevOptionsGluster
*gconf
,
488 QDict
*options
, Error
**errp
)
491 SocketAddress
*gsconf
= NULL
;
492 SocketAddressList
*curr
= NULL
;
493 QDict
*backing_options
= NULL
;
494 Error
*local_err
= NULL
;
497 int i
, type
, num_servers
;
499 /* create opts info from runtime_json_opts list */
500 opts
= qemu_opts_create(&runtime_json_opts
, NULL
, 0, &error_abort
);
501 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
506 num_servers
= qdict_array_entries(options
, GLUSTER_OPT_SERVER_PATTERN
);
507 if (num_servers
< 1) {
508 error_setg(&local_err
, QERR_MISSING_PARAMETER
, "server");
512 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_VOLUME
);
514 error_setg(&local_err
, QERR_MISSING_PARAMETER
, GLUSTER_OPT_VOLUME
);
517 gconf
->volume
= g_strdup(ptr
);
519 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_PATH
);
521 error_setg(&local_err
, QERR_MISSING_PARAMETER
, GLUSTER_OPT_PATH
);
524 gconf
->path
= g_strdup(ptr
);
527 for (i
= 0; i
< num_servers
; i
++) {
528 str
= g_strdup_printf(GLUSTER_OPT_SERVER_PATTERN
"%d.", i
);
529 qdict_extract_subqdict(options
, &backing_options
, str
);
531 /* create opts info from runtime_type_opts list */
532 opts
= qemu_opts_create(&runtime_type_opts
, NULL
, 0, &error_abort
);
533 qemu_opts_absorb_qdict(opts
, backing_options
, &local_err
);
538 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_TYPE
);
540 error_setg(&local_err
, QERR_MISSING_PARAMETER
, GLUSTER_OPT_TYPE
);
541 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
545 gsconf
= g_new0(SocketAddress
, 1);
546 if (!strcmp(ptr
, "tcp")) {
547 ptr
= "inet"; /* accept legacy "tcp" */
549 type
= qapi_enum_parse(&SocketAddressType_lookup
, ptr
, -1, NULL
);
550 if (type
!= SOCKET_ADDRESS_TYPE_INET
551 && type
!= SOCKET_ADDRESS_TYPE_UNIX
) {
552 error_setg(&local_err
,
553 "Parameter '%s' may be 'inet' or 'unix'",
555 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
561 if (gsconf
->type
== SOCKET_ADDRESS_TYPE_INET
) {
562 /* create opts info from runtime_inet_opts list */
563 opts
= qemu_opts_create(&runtime_inet_opts
, NULL
, 0, &error_abort
);
564 qemu_opts_absorb_qdict(opts
, backing_options
, &local_err
);
569 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_HOST
);
571 error_setg(&local_err
, QERR_MISSING_PARAMETER
,
573 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
576 gsconf
->u
.inet
.host
= g_strdup(ptr
);
577 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_PORT
);
579 error_setg(&local_err
, QERR_MISSING_PARAMETER
,
581 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
584 gsconf
->u
.inet
.port
= g_strdup(ptr
);
586 /* defend for unsupported fields in InetSocketAddress,
587 * i.e. @ipv4, @ipv6 and @to
589 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_TO
);
591 gsconf
->u
.inet
.has_to
= true;
593 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_IPV4
);
595 gsconf
->u
.inet
.has_ipv4
= true;
597 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_IPV6
);
599 gsconf
->u
.inet
.has_ipv6
= true;
601 if (gsconf
->u
.inet
.has_to
) {
602 error_setg(&local_err
, "Parameter 'to' not supported");
605 if (gsconf
->u
.inet
.has_ipv4
|| gsconf
->u
.inet
.has_ipv6
) {
606 error_setg(&local_err
, "Parameters 'ipv4/ipv6' not supported");
611 /* create opts info from runtime_unix_opts list */
612 opts
= qemu_opts_create(&runtime_unix_opts
, NULL
, 0, &error_abort
);
613 qemu_opts_absorb_qdict(opts
, backing_options
, &local_err
);
618 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_SOCKET
);
620 error_setg(&local_err
, QERR_MISSING_PARAMETER
,
622 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
625 gsconf
->u
.q_unix
.path
= g_strdup(ptr
);
629 if (gconf
->server
== NULL
) {
630 gconf
->server
= g_new0(SocketAddressList
, 1);
631 gconf
->server
->value
= gsconf
;
632 curr
= gconf
->server
;
634 curr
->next
= g_new0(SocketAddressList
, 1);
635 curr
->next
->value
= gsconf
;
640 QDECREF(backing_options
);
641 backing_options
= NULL
;
649 error_propagate(errp
, local_err
);
650 qapi_free_SocketAddress(gsconf
);
653 QDECREF(backing_options
);
658 /* Converts options given in @filename and the @options QDict into the QAPI
660 static int qemu_gluster_parse(BlockdevOptionsGluster
*gconf
,
661 const char *filename
,
662 QDict
*options
, Error
**errp
)
666 ret
= qemu_gluster_parse_uri(gconf
, filename
);
668 error_setg(errp
, "invalid URI");
669 error_append_hint(errp
, "Usage: file=gluster[+transport]://"
670 "[host[:port]]volume/path[?socket=...]"
672 "[,file.logfile=/path/filename.log]\n");
676 ret
= qemu_gluster_parse_json(gconf
, options
, errp
);
678 error_append_hint(errp
, "Usage: "
679 "-drive driver=qcow2,file.driver=gluster,"
680 "file.volume=testvol,file.path=/path/a.qcow2"
682 "[,file.logfile=/path/filename.log],"
683 "file.server.0.type=inet,"
684 "file.server.0.host=1.2.3.4,"
685 "file.server.0.port=24007,"
686 "file.server.1.transport=unix,"
687 "file.server.1.socket=/var/run/glusterd.socket ..."
696 static struct glfs
*qemu_gluster_init(BlockdevOptionsGluster
*gconf
,
697 const char *filename
,
698 QDict
*options
, Error
**errp
)
702 ret
= qemu_gluster_parse(gconf
, filename
, options
, errp
);
708 return qemu_gluster_glfs_init(gconf
, errp
);
712 * AIO callback routine called from GlusterFS thread.
714 static void gluster_finish_aiocb(struct glfs_fd
*fd
, ssize_t ret
, void *arg
)
716 GlusterAIOCB
*acb
= (GlusterAIOCB
*)arg
;
718 if (!ret
|| ret
== acb
->size
) {
719 acb
->ret
= 0; /* Success */
720 } else if (ret
< 0) {
721 acb
->ret
= -errno
; /* Read/Write failed */
723 acb
->ret
= -EIO
; /* Partial read/write - fail it */
726 aio_co_schedule(acb
->aio_context
, acb
->coroutine
);
729 static void qemu_gluster_parse_flags(int bdrv_flags
, int *open_flags
)
731 assert(open_flags
!= NULL
);
733 *open_flags
|= O_BINARY
;
735 if (bdrv_flags
& BDRV_O_RDWR
) {
736 *open_flags
|= O_RDWR
;
738 *open_flags
|= O_RDONLY
;
741 if ((bdrv_flags
& BDRV_O_NOCACHE
)) {
742 *open_flags
|= O_DIRECT
;
747 * Do SEEK_DATA/HOLE to detect if it is functional. Older broken versions of
748 * gfapi incorrectly return the current offset when SEEK_DATA/HOLE is used.
749 * - Corrected versions return -1 and set errno to EINVAL.
750 * - Versions that support SEEK_DATA/HOLE correctly, will return -1 and set
751 * errno to ENXIO when SEEK_DATA is called with a position of EOF.
753 static bool qemu_gluster_test_seek(struct glfs_fd
*fd
)
757 #if defined SEEK_HOLE && defined SEEK_DATA
760 eof
= glfs_lseek(fd
, 0, SEEK_END
);
762 /* this should never occur */
766 /* this should always fail with ENXIO if SEEK_DATA is supported */
767 ret
= glfs_lseek(fd
, eof
, SEEK_DATA
);
770 return (ret
< 0) && (errno
== ENXIO
);
773 static int qemu_gluster_open(BlockDriverState
*bs
, QDict
*options
,
774 int bdrv_flags
, Error
**errp
)
776 BDRVGlusterState
*s
= bs
->opaque
;
779 BlockdevOptionsGluster
*gconf
= NULL
;
781 Error
*local_err
= NULL
;
782 const char *filename
, *logfile
;
784 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
785 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
787 error_propagate(errp
, local_err
);
792 filename
= qemu_opt_get(opts
, GLUSTER_OPT_FILENAME
);
794 s
->debug
= qemu_opt_get_number(opts
, GLUSTER_OPT_DEBUG
,
795 GLUSTER_DEBUG_DEFAULT
);
798 } else if (s
->debug
> GLUSTER_DEBUG_MAX
) {
799 s
->debug
= GLUSTER_DEBUG_MAX
;
802 gconf
= g_new0(BlockdevOptionsGluster
, 1);
803 gconf
->debug
= s
->debug
;
804 gconf
->has_debug
= true;
806 logfile
= qemu_opt_get(opts
, GLUSTER_OPT_LOGFILE
);
807 s
->logfile
= g_strdup(logfile
? logfile
: GLUSTER_LOGFILE_DEFAULT
);
809 gconf
->logfile
= g_strdup(s
->logfile
);
810 gconf
->has_logfile
= true;
812 s
->glfs
= qemu_gluster_init(gconf
, filename
, options
, errp
);
818 #ifdef CONFIG_GLUSTERFS_XLATOR_OPT
819 /* Without this, if fsync fails for a recoverable reason (for instance,
820 * ENOSPC), gluster will dump its cache, preventing retries. This means
821 * almost certain data loss. Not all gluster versions support the
822 * 'resync-failed-syncs-after-fsync' key value, but there is no way to
823 * discover during runtime if it is supported (this api returns success for
824 * unknown key/value pairs) */
825 ret
= glfs_set_xlator_option(s
->glfs
, "*-write-behind",
826 "resync-failed-syncs-after-fsync",
829 error_setg_errno(errp
, errno
, "Unable to set xlator key/value pair");
835 qemu_gluster_parse_flags(bdrv_flags
, &open_flags
);
837 s
->fd
= glfs_open(s
->glfs
, gconf
->path
, open_flags
);
842 s
->supports_seek_data
= qemu_gluster_test_seek(s
->fd
);
846 qapi_free_BlockdevOptionsGluster(gconf
);
855 glfs_clear_preopened(s
->glfs
);
860 static int qemu_gluster_reopen_prepare(BDRVReopenState
*state
,
861 BlockReopenQueue
*queue
, Error
**errp
)
865 BDRVGlusterReopenState
*reop_s
;
866 BlockdevOptionsGluster
*gconf
;
869 assert(state
!= NULL
);
870 assert(state
->bs
!= NULL
);
872 s
= state
->bs
->opaque
;
874 state
->opaque
= g_new0(BDRVGlusterReopenState
, 1);
875 reop_s
= state
->opaque
;
877 qemu_gluster_parse_flags(state
->flags
, &open_flags
);
879 gconf
= g_new0(BlockdevOptionsGluster
, 1);
880 gconf
->debug
= s
->debug
;
881 gconf
->has_debug
= true;
882 gconf
->logfile
= g_strdup(s
->logfile
);
883 gconf
->has_logfile
= true;
884 reop_s
->glfs
= qemu_gluster_init(gconf
, state
->bs
->filename
, NULL
, errp
);
885 if (reop_s
->glfs
== NULL
) {
890 #ifdef CONFIG_GLUSTERFS_XLATOR_OPT
891 ret
= glfs_set_xlator_option(reop_s
->glfs
, "*-write-behind",
892 "resync-failed-syncs-after-fsync", "on");
894 error_setg_errno(errp
, errno
, "Unable to set xlator key/value pair");
900 reop_s
->fd
= glfs_open(reop_s
->glfs
, gconf
->path
, open_flags
);
901 if (reop_s
->fd
== NULL
) {
902 /* reops->glfs will be cleaned up in _abort */
908 /* state->opaque will be freed in either the _abort or _commit */
909 qapi_free_BlockdevOptionsGluster(gconf
);
913 static void qemu_gluster_reopen_commit(BDRVReopenState
*state
)
915 BDRVGlusterReopenState
*reop_s
= state
->opaque
;
916 BDRVGlusterState
*s
= state
->bs
->opaque
;
924 glfs_clear_preopened(s
->glfs
);
926 /* use the newly opened image / connection */
928 s
->glfs
= reop_s
->glfs
;
930 g_free(state
->opaque
);
931 state
->opaque
= NULL
;
937 static void qemu_gluster_reopen_abort(BDRVReopenState
*state
)
939 BDRVGlusterReopenState
*reop_s
= state
->opaque
;
941 if (reop_s
== NULL
) {
946 glfs_close(reop_s
->fd
);
949 glfs_clear_preopened(reop_s
->glfs
);
951 g_free(state
->opaque
);
952 state
->opaque
= NULL
;
957 #ifdef CONFIG_GLUSTERFS_ZEROFILL
958 static coroutine_fn
int qemu_gluster_co_pwrite_zeroes(BlockDriverState
*bs
,
961 BdrvRequestFlags flags
)
965 BDRVGlusterState
*s
= bs
->opaque
;
969 acb
.coroutine
= qemu_coroutine_self();
970 acb
.aio_context
= bdrv_get_aio_context(bs
);
972 ret
= glfs_zerofill_async(s
->fd
, offset
, size
, gluster_finish_aiocb
, &acb
);
977 qemu_coroutine_yield();
982 static int qemu_gluster_do_truncate(struct glfs_fd
*fd
, int64_t offset
,
983 PreallocMode prealloc
, Error
**errp
)
985 int64_t current_length
;
987 current_length
= glfs_lseek(fd
, 0, SEEK_END
);
988 if (current_length
< 0) {
989 error_setg_errno(errp
, errno
, "Failed to determine current size");
993 if (current_length
> offset
&& prealloc
!= PREALLOC_MODE_OFF
) {
994 error_setg(errp
, "Cannot use preallocation for shrinking files");
998 if (current_length
== offset
) {
1003 #ifdef CONFIG_GLUSTERFS_FALLOCATE
1004 case PREALLOC_MODE_FALLOC
:
1005 if (glfs_fallocate(fd
, 0, current_length
, offset
- current_length
)) {
1006 error_setg_errno(errp
, errno
, "Could not preallocate data");
1010 #endif /* CONFIG_GLUSTERFS_FALLOCATE */
1011 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1012 case PREALLOC_MODE_FULL
:
1013 if (glfs_ftruncate(fd
, offset
)) {
1014 error_setg_errno(errp
, errno
, "Could not resize file");
1017 if (glfs_zerofill(fd
, current_length
, offset
- current_length
)) {
1018 error_setg_errno(errp
, errno
, "Could not zerofill the new area");
1022 #endif /* CONFIG_GLUSTERFS_ZEROFILL */
1023 case PREALLOC_MODE_OFF
:
1024 if (glfs_ftruncate(fd
, offset
)) {
1025 error_setg_errno(errp
, errno
, "Could not resize file");
1030 error_setg(errp
, "Unsupported preallocation mode: %s",
1031 PreallocMode_str(prealloc
));
1038 static int qemu_gluster_co_create(BlockdevCreateOptions
*options
,
1041 BlockdevCreateOptionsGluster
*opts
= &options
->u
.gluster
;
1043 struct glfs_fd
*fd
= NULL
;
1046 assert(options
->driver
== BLOCKDEV_DRIVER_GLUSTER
);
1048 glfs
= qemu_gluster_glfs_init(opts
->location
, errp
);
1054 fd
= glfs_creat(glfs
, opts
->location
->path
,
1055 O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
, S_IRUSR
| S_IWUSR
);
1061 ret
= qemu_gluster_do_truncate(fd
, opts
->size
, opts
->preallocation
, errp
);
1065 if (glfs_close(fd
) != 0 && ret
== 0) {
1069 glfs_clear_preopened(glfs
);
1073 static int coroutine_fn
qemu_gluster_co_create_opts(const char *filename
,
1077 BlockdevCreateOptions
*options
;
1078 BlockdevCreateOptionsGluster
*gopts
;
1079 BlockdevOptionsGluster
*gconf
;
1081 Error
*local_err
= NULL
;
1084 options
= g_new0(BlockdevCreateOptions
, 1);
1085 options
->driver
= BLOCKDEV_DRIVER_GLUSTER
;
1086 gopts
= &options
->u
.gluster
;
1088 gconf
= g_new0(BlockdevOptionsGluster
, 1);
1089 gopts
->location
= gconf
;
1091 gopts
->size
= ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
1094 tmp
= qemu_opt_get_del(opts
, BLOCK_OPT_PREALLOC
);
1095 gopts
->preallocation
= qapi_enum_parse(&PreallocMode_lookup
, tmp
,
1096 PREALLOC_MODE_OFF
, &local_err
);
1099 error_propagate(errp
, local_err
);
1104 gconf
->debug
= qemu_opt_get_number_del(opts
, GLUSTER_OPT_DEBUG
,
1105 GLUSTER_DEBUG_DEFAULT
);
1106 if (gconf
->debug
< 0) {
1108 } else if (gconf
->debug
> GLUSTER_DEBUG_MAX
) {
1109 gconf
->debug
= GLUSTER_DEBUG_MAX
;
1111 gconf
->has_debug
= true;
1113 gconf
->logfile
= qemu_opt_get_del(opts
, GLUSTER_OPT_LOGFILE
);
1114 if (!gconf
->logfile
) {
1115 gconf
->logfile
= g_strdup(GLUSTER_LOGFILE_DEFAULT
);
1117 gconf
->has_logfile
= true;
1119 ret
= qemu_gluster_parse(gconf
, filename
, NULL
, errp
);
1124 ret
= qemu_gluster_co_create(options
, errp
);
1131 qapi_free_BlockdevCreateOptions(options
);
1135 static coroutine_fn
int qemu_gluster_co_rw(BlockDriverState
*bs
,
1136 int64_t sector_num
, int nb_sectors
,
1137 QEMUIOVector
*qiov
, int write
)
1141 BDRVGlusterState
*s
= bs
->opaque
;
1142 size_t size
= nb_sectors
* BDRV_SECTOR_SIZE
;
1143 off_t offset
= sector_num
* BDRV_SECTOR_SIZE
;
1147 acb
.coroutine
= qemu_coroutine_self();
1148 acb
.aio_context
= bdrv_get_aio_context(bs
);
1151 ret
= glfs_pwritev_async(s
->fd
, qiov
->iov
, qiov
->niov
, offset
, 0,
1152 gluster_finish_aiocb
, &acb
);
1154 ret
= glfs_preadv_async(s
->fd
, qiov
->iov
, qiov
->niov
, offset
, 0,
1155 gluster_finish_aiocb
, &acb
);
1162 qemu_coroutine_yield();
1166 static int qemu_gluster_truncate(BlockDriverState
*bs
, int64_t offset
,
1167 PreallocMode prealloc
, Error
**errp
)
1169 BDRVGlusterState
*s
= bs
->opaque
;
1170 return qemu_gluster_do_truncate(s
->fd
, offset
, prealloc
, errp
);
1173 static coroutine_fn
int qemu_gluster_co_readv(BlockDriverState
*bs
,
1178 return qemu_gluster_co_rw(bs
, sector_num
, nb_sectors
, qiov
, 0);
1181 static coroutine_fn
int qemu_gluster_co_writev(BlockDriverState
*bs
,
1186 return qemu_gluster_co_rw(bs
, sector_num
, nb_sectors
, qiov
, 1);
1189 static void qemu_gluster_close(BlockDriverState
*bs
)
1191 BDRVGlusterState
*s
= bs
->opaque
;
1198 glfs_clear_preopened(s
->glfs
);
1201 static coroutine_fn
int qemu_gluster_co_flush_to_disk(BlockDriverState
*bs
)
1205 BDRVGlusterState
*s
= bs
->opaque
;
1209 acb
.coroutine
= qemu_coroutine_self();
1210 acb
.aio_context
= bdrv_get_aio_context(bs
);
1212 ret
= glfs_fsync_async(s
->fd
, gluster_finish_aiocb
, &acb
);
1218 qemu_coroutine_yield();
1227 /* Some versions of Gluster (3.5.6 -> 3.5.8?) will not retain its cache
1228 * after a fsync failure, so we have no way of allowing the guest to safely
1229 * continue. Gluster versions prior to 3.5.6 don't retain the cache
1230 * either, but will invalidate the fd on error, so this is again our only
1233 * The 'resync-failed-syncs-after-fsync' xlator option for the
1234 * write-behind cache will cause later gluster versions to retain its
1235 * cache after error, so long as the fd remains open. However, we
1236 * currently have no way of knowing if this option is supported.
1238 * TODO: Once gluster provides a way for us to determine if the option
1239 * is supported, bypass the closure and setting drv to NULL. */
1240 qemu_gluster_close(bs
);
1245 #ifdef CONFIG_GLUSTERFS_DISCARD
1246 static coroutine_fn
int qemu_gluster_co_pdiscard(BlockDriverState
*bs
,
1247 int64_t offset
, int size
)
1251 BDRVGlusterState
*s
= bs
->opaque
;
1255 acb
.coroutine
= qemu_coroutine_self();
1256 acb
.aio_context
= bdrv_get_aio_context(bs
);
1258 ret
= glfs_discard_async(s
->fd
, offset
, size
, gluster_finish_aiocb
, &acb
);
1263 qemu_coroutine_yield();
1268 static int64_t qemu_gluster_getlength(BlockDriverState
*bs
)
1270 BDRVGlusterState
*s
= bs
->opaque
;
1273 ret
= glfs_lseek(s
->fd
, 0, SEEK_END
);
1281 static int64_t qemu_gluster_allocated_file_size(BlockDriverState
*bs
)
1283 BDRVGlusterState
*s
= bs
->opaque
;
1287 ret
= glfs_fstat(s
->fd
, &st
);
1291 return st
.st_blocks
* 512;
1295 static int qemu_gluster_has_zero_init(BlockDriverState
*bs
)
1297 /* GlusterFS volume could be backed by a block device */
1302 * Find allocation range in @bs around offset @start.
1303 * May change underlying file descriptor's file offset.
1304 * If @start is not in a hole, store @start in @data, and the
1305 * beginning of the next hole in @hole, and return 0.
1306 * If @start is in a non-trailing hole, store @start in @hole and the
1307 * beginning of the next non-hole in @data, and return 0.
1308 * If @start is in a trailing hole or beyond EOF, return -ENXIO.
1309 * If we can't find out, return a negative errno other than -ENXIO.
1311 * (Shamefully copied from file-posix.c, only miniscule adaptions.)
1313 static int find_allocation(BlockDriverState
*bs
, off_t start
,
1314 off_t
*data
, off_t
*hole
)
1316 BDRVGlusterState
*s
= bs
->opaque
;
1318 if (!s
->supports_seek_data
) {
1322 #if defined SEEK_HOLE && defined SEEK_DATA
1327 * D1. offs == start: start is in data
1328 * D2. offs > start: start is in a hole, next data at offs
1329 * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
1330 * or start is beyond EOF
1331 * If the latter happens, the file has been truncated behind
1332 * our back since we opened it. All bets are off then.
1333 * Treating like a trailing hole is simplest.
1334 * D4. offs < 0, errno != ENXIO: we learned nothing
1336 offs
= glfs_lseek(s
->fd
, start
, SEEK_DATA
);
1338 return -errno
; /* D3 or D4 */
1342 /* This is not a valid return by lseek(). We are safe to just return
1343 * -EIO in this case, and we'll treat it like D4. Unfortunately some
1344 * versions of gluster server will return offs < start, so an assert
1345 * here will unnecessarily abort QEMU. */
1350 /* D2: in hole, next data at offs */
1356 /* D1: in data, end not yet known */
1360 * H1. offs == start: start is in a hole
1361 * If this happens here, a hole has been dug behind our back
1362 * since the previous lseek().
1363 * H2. offs > start: either start is in data, next hole at offs,
1364 * or start is in trailing hole, EOF at offs
1365 * Linux treats trailing holes like any other hole: offs ==
1366 * start. Solaris seeks to EOF instead: offs > start (blech).
1367 * If that happens here, a hole has been dug behind our back
1368 * since the previous lseek().
1369 * H3. offs < 0, errno = ENXIO: start is beyond EOF
1370 * If this happens, the file has been truncated behind our
1371 * back since we opened it. Treat it like a trailing hole.
1372 * H4. offs < 0, errno != ENXIO: we learned nothing
1373 * Pretend we know nothing at all, i.e. "forget" about D1.
1375 offs
= glfs_lseek(s
->fd
, start
, SEEK_HOLE
);
1377 return -errno
; /* D1 and (H3 or H4) */
1381 /* This is not a valid return by lseek(). We are safe to just return
1382 * -EIO in this case, and we'll treat it like H4. Unfortunately some
1383 * versions of gluster server will return offs < start, so an assert
1384 * here will unnecessarily abort QEMU. */
1390 * D1 and H2: either in data, next hole at offs, or it was in
1391 * data but is now in a trailing hole. In the latter case,
1392 * all bets are off. Treating it as if it there was data all
1393 * the way to EOF is safe, so simply do that.
1409 * Returns the allocation status of the specified offset.
1411 * The block layer guarantees 'offset' and 'bytes' are within bounds.
1413 * 'pnum' is set to the number of bytes (including and immediately following
1414 * the specified offset) that are known to be in the same
1415 * allocated/unallocated state.
1417 * 'bytes' is the max value 'pnum' should be set to.
1419 * (Based on raw_co_block_status() from file-posix.c.)
1421 static int coroutine_fn
qemu_gluster_co_block_status(BlockDriverState
*bs
,
1427 BlockDriverState
**file
)
1429 BDRVGlusterState
*s
= bs
->opaque
;
1430 off_t data
= 0, hole
= 0;
1441 return BDRV_BLOCK_DATA
| BDRV_BLOCK_OFFSET_VALID
;
1444 ret
= find_allocation(bs
, offset
, &data
, &hole
);
1445 if (ret
== -ENXIO
) {
1448 ret
= BDRV_BLOCK_ZERO
;
1449 } else if (ret
< 0) {
1450 /* No info available, so pretend there are no holes */
1452 ret
= BDRV_BLOCK_DATA
;
1453 } else if (data
== offset
) {
1454 /* On a data extent, compute bytes to the end of the extent,
1455 * possibly including a partial sector at EOF. */
1456 *pnum
= MIN(bytes
, hole
- offset
);
1457 ret
= BDRV_BLOCK_DATA
;
1459 /* On a hole, compute bytes to the beginning of the next extent. */
1460 assert(hole
== offset
);
1461 *pnum
= MIN(bytes
, data
- offset
);
1462 ret
= BDRV_BLOCK_ZERO
;
1468 return ret
| BDRV_BLOCK_OFFSET_VALID
;
1472 static BlockDriver bdrv_gluster
= {
1473 .format_name
= "gluster",
1474 .protocol_name
= "gluster",
1475 .instance_size
= sizeof(BDRVGlusterState
),
1476 .bdrv_needs_filename
= false,
1477 .bdrv_file_open
= qemu_gluster_open
,
1478 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1479 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1480 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1481 .bdrv_close
= qemu_gluster_close
,
1482 .bdrv_co_create
= qemu_gluster_co_create
,
1483 .bdrv_co_create_opts
= qemu_gluster_co_create_opts
,
1484 .bdrv_getlength
= qemu_gluster_getlength
,
1485 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1486 .bdrv_truncate
= qemu_gluster_truncate
,
1487 .bdrv_co_readv
= qemu_gluster_co_readv
,
1488 .bdrv_co_writev
= qemu_gluster_co_writev
,
1489 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1490 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1491 #ifdef CONFIG_GLUSTERFS_DISCARD
1492 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1494 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1495 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1497 .bdrv_co_block_status
= qemu_gluster_co_block_status
,
1498 .create_opts
= &qemu_gluster_create_opts
,
1501 static BlockDriver bdrv_gluster_tcp
= {
1502 .format_name
= "gluster",
1503 .protocol_name
= "gluster+tcp",
1504 .instance_size
= sizeof(BDRVGlusterState
),
1505 .bdrv_needs_filename
= false,
1506 .bdrv_file_open
= qemu_gluster_open
,
1507 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1508 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1509 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1510 .bdrv_close
= qemu_gluster_close
,
1511 .bdrv_co_create
= qemu_gluster_co_create
,
1512 .bdrv_co_create_opts
= qemu_gluster_co_create_opts
,
1513 .bdrv_getlength
= qemu_gluster_getlength
,
1514 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1515 .bdrv_truncate
= qemu_gluster_truncate
,
1516 .bdrv_co_readv
= qemu_gluster_co_readv
,
1517 .bdrv_co_writev
= qemu_gluster_co_writev
,
1518 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1519 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1520 #ifdef CONFIG_GLUSTERFS_DISCARD
1521 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1523 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1524 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1526 .bdrv_co_block_status
= qemu_gluster_co_block_status
,
1527 .create_opts
= &qemu_gluster_create_opts
,
1530 static BlockDriver bdrv_gluster_unix
= {
1531 .format_name
= "gluster",
1532 .protocol_name
= "gluster+unix",
1533 .instance_size
= sizeof(BDRVGlusterState
),
1534 .bdrv_needs_filename
= true,
1535 .bdrv_file_open
= qemu_gluster_open
,
1536 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1537 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1538 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1539 .bdrv_close
= qemu_gluster_close
,
1540 .bdrv_co_create
= qemu_gluster_co_create
,
1541 .bdrv_co_create_opts
= qemu_gluster_co_create_opts
,
1542 .bdrv_getlength
= qemu_gluster_getlength
,
1543 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1544 .bdrv_truncate
= qemu_gluster_truncate
,
1545 .bdrv_co_readv
= qemu_gluster_co_readv
,
1546 .bdrv_co_writev
= qemu_gluster_co_writev
,
1547 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1548 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1549 #ifdef CONFIG_GLUSTERFS_DISCARD
1550 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1552 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1553 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1555 .bdrv_co_block_status
= qemu_gluster_co_block_status
,
1556 .create_opts
= &qemu_gluster_create_opts
,
1559 /* rdma is deprecated (actually never supported for volfile fetch).
1560 * Let's maintain it for the protocol compatibility, to make sure things
1561 * won't break immediately. For now, gluster+rdma will fall back to gluster+tcp
1562 * protocol with a warning.
1563 * TODO: remove gluster+rdma interface support
1565 static BlockDriver bdrv_gluster_rdma
= {
1566 .format_name
= "gluster",
1567 .protocol_name
= "gluster+rdma",
1568 .instance_size
= sizeof(BDRVGlusterState
),
1569 .bdrv_needs_filename
= true,
1570 .bdrv_file_open
= qemu_gluster_open
,
1571 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1572 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1573 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1574 .bdrv_close
= qemu_gluster_close
,
1575 .bdrv_co_create
= qemu_gluster_co_create
,
1576 .bdrv_co_create_opts
= qemu_gluster_co_create_opts
,
1577 .bdrv_getlength
= qemu_gluster_getlength
,
1578 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1579 .bdrv_truncate
= qemu_gluster_truncate
,
1580 .bdrv_co_readv
= qemu_gluster_co_readv
,
1581 .bdrv_co_writev
= qemu_gluster_co_writev
,
1582 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1583 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1584 #ifdef CONFIG_GLUSTERFS_DISCARD
1585 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1587 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1588 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1590 .bdrv_co_block_status
= qemu_gluster_co_block_status
,
1591 .create_opts
= &qemu_gluster_create_opts
,
1594 static void bdrv_gluster_init(void)
1596 bdrv_register(&bdrv_gluster_rdma
);
1597 bdrv_register(&bdrv_gluster_unix
);
1598 bdrv_register(&bdrv_gluster_tcp
);
1599 bdrv_register(&bdrv_gluster
);
1602 block_init(bdrv_gluster_init
);