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 "qemu/osdep.h"
11 #include <glusterfs/api/glfs.h>
12 #include "block/block_int.h"
13 #include "qapi/error.h"
14 #include "qapi/qmp/qerror.h"
16 #include "qemu/error-report.h"
17 #include "qemu/cutils.h"
19 #define GLUSTER_OPT_FILENAME "filename"
20 #define GLUSTER_OPT_VOLUME "volume"
21 #define GLUSTER_OPT_PATH "path"
22 #define GLUSTER_OPT_TYPE "type"
23 #define GLUSTER_OPT_SERVER_PATTERN "server."
24 #define GLUSTER_OPT_HOST "host"
25 #define GLUSTER_OPT_PORT "port"
26 #define GLUSTER_OPT_TO "to"
27 #define GLUSTER_OPT_IPV4 "ipv4"
28 #define GLUSTER_OPT_IPV6 "ipv6"
29 #define GLUSTER_OPT_SOCKET "socket"
30 #define GLUSTER_OPT_DEBUG "debug"
31 #define GLUSTER_DEFAULT_PORT 24007
32 #define GLUSTER_DEBUG_DEFAULT 4
33 #define GLUSTER_DEBUG_MAX 9
34 #define GLUSTER_OPT_LOGFILE "logfile"
35 #define GLUSTER_LOGFILE_DEFAULT "-" /* handled in libgfapi as /dev/stderr */
37 #define GERR_INDEX_HINT "hint: check in 'server' array index '%d'\n"
39 typedef struct GlusterAIOCB
{
43 AioContext
*aio_context
;
46 typedef struct BDRVGlusterState
{
50 bool supports_seek_data
;
54 typedef struct BDRVGlusterReopenState
{
57 } BDRVGlusterReopenState
;
60 typedef struct GlfsPreopened
{
66 typedef struct ListElement
{
67 QLIST_ENTRY(ListElement
) list
;
71 static QLIST_HEAD(glfs_list
, ListElement
) glfs_list
;
73 static QemuOptsList qemu_gluster_create_opts
= {
74 .name
= "qemu-gluster-create-opts",
75 .head
= QTAILQ_HEAD_INITIALIZER(qemu_gluster_create_opts
.head
),
78 .name
= BLOCK_OPT_SIZE
,
79 .type
= QEMU_OPT_SIZE
,
80 .help
= "Virtual disk size"
83 .name
= BLOCK_OPT_PREALLOC
,
84 .type
= QEMU_OPT_STRING
,
85 .help
= "Preallocation mode (allowed values: off, full)"
88 .name
= GLUSTER_OPT_DEBUG
,
89 .type
= QEMU_OPT_NUMBER
,
90 .help
= "Gluster log level, valid range is 0-9",
93 .name
= GLUSTER_OPT_LOGFILE
,
94 .type
= QEMU_OPT_STRING
,
95 .help
= "Logfile path of libgfapi",
101 static QemuOptsList runtime_opts
= {
103 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
106 .name
= GLUSTER_OPT_FILENAME
,
107 .type
= QEMU_OPT_STRING
,
108 .help
= "URL to the gluster image",
111 .name
= GLUSTER_OPT_DEBUG
,
112 .type
= QEMU_OPT_NUMBER
,
113 .help
= "Gluster log level, valid range is 0-9",
116 .name
= GLUSTER_OPT_LOGFILE
,
117 .type
= QEMU_OPT_STRING
,
118 .help
= "Logfile path of libgfapi",
120 { /* end of list */ }
124 static QemuOptsList runtime_json_opts
= {
125 .name
= "gluster_json",
126 .head
= QTAILQ_HEAD_INITIALIZER(runtime_json_opts
.head
),
129 .name
= GLUSTER_OPT_VOLUME
,
130 .type
= QEMU_OPT_STRING
,
131 .help
= "name of gluster volume where VM image resides",
134 .name
= GLUSTER_OPT_PATH
,
135 .type
= QEMU_OPT_STRING
,
136 .help
= "absolute path to image file in gluster volume",
139 .name
= GLUSTER_OPT_DEBUG
,
140 .type
= QEMU_OPT_NUMBER
,
141 .help
= "Gluster log level, valid range is 0-9",
143 { /* end of list */ }
147 static QemuOptsList runtime_type_opts
= {
148 .name
= "gluster_type",
149 .head
= QTAILQ_HEAD_INITIALIZER(runtime_type_opts
.head
),
152 .name
= GLUSTER_OPT_TYPE
,
153 .type
= QEMU_OPT_STRING
,
156 { /* end of list */ }
160 static QemuOptsList runtime_unix_opts
= {
161 .name
= "gluster_unix",
162 .head
= QTAILQ_HEAD_INITIALIZER(runtime_unix_opts
.head
),
165 .name
= GLUSTER_OPT_SOCKET
,
166 .type
= QEMU_OPT_STRING
,
167 .help
= "socket file path)",
169 { /* end of list */ }
173 static QemuOptsList runtime_tcp_opts
= {
174 .name
= "gluster_tcp",
175 .head
= QTAILQ_HEAD_INITIALIZER(runtime_tcp_opts
.head
),
178 .name
= GLUSTER_OPT_TYPE
,
179 .type
= QEMU_OPT_STRING
,
183 .name
= GLUSTER_OPT_HOST
,
184 .type
= QEMU_OPT_STRING
,
185 .help
= "host address (hostname/ipv4/ipv6 addresses)",
188 .name
= GLUSTER_OPT_PORT
,
189 .type
= QEMU_OPT_STRING
,
190 .help
= "port number on which glusterd is listening (default 24007)",
194 .type
= QEMU_OPT_NUMBER
,
195 .help
= "max port number, not supported by gluster",
199 .type
= QEMU_OPT_BOOL
,
200 .help
= "ipv4 bool value, not supported by gluster",
204 .type
= QEMU_OPT_BOOL
,
205 .help
= "ipv6 bool value, not supported by gluster",
207 { /* end of list */ }
211 static void glfs_set_preopened(const char *volume
, glfs_t
*fs
)
213 ListElement
*entry
= NULL
;
215 entry
= g_new(ListElement
, 1);
217 entry
->saved
.volume
= g_strdup(volume
);
219 entry
->saved
.fs
= fs
;
220 entry
->saved
.ref
= 1;
222 QLIST_INSERT_HEAD(&glfs_list
, entry
, list
);
225 static glfs_t
*glfs_find_preopened(const char *volume
)
227 ListElement
*entry
= NULL
;
229 QLIST_FOREACH(entry
, &glfs_list
, list
) {
230 if (strcmp(entry
->saved
.volume
, volume
) == 0) {
232 return entry
->saved
.fs
;
239 static void glfs_clear_preopened(glfs_t
*fs
)
241 ListElement
*entry
= NULL
;
248 QLIST_FOREACH_SAFE(entry
, &glfs_list
, list
, next
) {
249 if (entry
->saved
.fs
== fs
) {
250 if (--entry
->saved
.ref
) {
254 QLIST_REMOVE(entry
, list
);
256 glfs_fini(entry
->saved
.fs
);
257 g_free(entry
->saved
.volume
);
263 static int parse_volume_options(BlockdevOptionsGluster
*gconf
, char *path
)
272 p
= q
= path
+ strspn(path
, "/");
273 p
+= strcspn(p
, "/");
277 gconf
->volume
= g_strndup(q
, p
- q
);
284 gconf
->path
= g_strdup(p
);
289 * file=gluster[+transport]://[host[:port]]/volume/path[?socket=...]
291 * 'gluster' is the protocol.
293 * 'transport' specifies the transport type used to connect to gluster
294 * management daemon (glusterd). Valid transport types are
295 * tcp or unix. If a transport type isn't specified, then tcp type is assumed.
297 * 'host' specifies the host where the volume file specification for
298 * the given volume resides. This can be either hostname or ipv4 address.
299 * If transport type is 'unix', then 'host' field should not be specified.
300 * The 'socket' field needs to be populated with the path to unix domain
303 * 'port' is the port number on which glusterd is listening. This is optional
304 * and if not specified, QEMU will send 0 which will make gluster to use the
305 * default port. If the transport type is unix, then 'port' should not be
308 * 'volume' is the name of the gluster volume which contains the VM image.
310 * 'path' is the path to the actual VM image that resides on gluster volume.
314 * file=gluster://1.2.3.4/testvol/a.img
315 * file=gluster+tcp://1.2.3.4/testvol/a.img
316 * file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
317 * file=gluster+tcp://host.domain.com:24007/testvol/dir/a.img
318 * file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
320 static int qemu_gluster_parse_uri(BlockdevOptionsGluster
*gconf
,
321 const char *filename
)
323 GlusterServer
*gsconf
;
325 QueryParams
*qp
= NULL
;
326 bool is_unix
= false;
329 uri
= uri_parse(filename
);
334 gconf
->server
= g_new0(GlusterServerList
, 1);
335 gconf
->server
->value
= gsconf
= g_new0(GlusterServer
, 1);
338 if (!uri
->scheme
|| !strcmp(uri
->scheme
, "gluster")) {
339 gsconf
->type
= GLUSTER_TRANSPORT_TCP
;
340 } else if (!strcmp(uri
->scheme
, "gluster+tcp")) {
341 gsconf
->type
= GLUSTER_TRANSPORT_TCP
;
342 } else if (!strcmp(uri
->scheme
, "gluster+unix")) {
343 gsconf
->type
= GLUSTER_TRANSPORT_UNIX
;
345 } else if (!strcmp(uri
->scheme
, "gluster+rdma")) {
346 gsconf
->type
= GLUSTER_TRANSPORT_TCP
;
347 error_report("Warning: rdma feature is not supported, falling "
354 ret
= parse_volume_options(gconf
, uri
->path
);
359 qp
= query_params_parse(uri
->query
);
360 if (qp
->n
> 1 || (is_unix
&& !qp
->n
) || (!is_unix
&& qp
->n
)) {
366 if (uri
->server
|| uri
->port
) {
370 if (strcmp(qp
->p
[0].name
, "socket")) {
374 gsconf
->u
.q_unix
.path
= g_strdup(qp
->p
[0].value
);
376 gsconf
->u
.tcp
.host
= g_strdup(uri
->server
? uri
->server
: "localhost");
378 gsconf
->u
.tcp
.port
= g_strdup_printf("%d", uri
->port
);
380 gsconf
->u
.tcp
.port
= g_strdup_printf("%d", GLUSTER_DEFAULT_PORT
);
386 query_params_free(qp
);
392 static struct glfs
*qemu_gluster_glfs_init(BlockdevOptionsGluster
*gconf
,
398 GlusterServerList
*server
;
399 unsigned long long port
;
401 glfs
= glfs_find_preopened(gconf
->volume
);
406 glfs
= glfs_new(gconf
->volume
);
411 glfs_set_preopened(gconf
->volume
, glfs
);
413 for (server
= gconf
->server
; server
; server
= server
->next
) {
414 if (server
->value
->type
== GLUSTER_TRANSPORT_UNIX
) {
415 ret
= glfs_set_volfile_server(glfs
, "unix",
416 server
->value
->u
.q_unix
.path
, 0);
418 if (parse_uint_full(server
->value
->u
.tcp
.port
, &port
, 10) < 0 ||
420 error_setg(errp
, "'%s' is not a valid port number",
421 server
->value
->u
.tcp
.port
);
425 ret
= glfs_set_volfile_server(glfs
, "tcp",
426 server
->value
->u
.tcp
.host
,
435 ret
= glfs_set_logging(glfs
, gconf
->logfile
, gconf
->debug
);
440 ret
= glfs_init(glfs
);
442 error_setg(errp
, "Gluster connection for volume %s, path %s failed"
443 " to connect", gconf
->volume
, gconf
->path
);
444 for (server
= gconf
->server
; server
; server
= server
->next
) {
445 if (server
->value
->type
== GLUSTER_TRANSPORT_UNIX
) {
446 error_append_hint(errp
, "hint: failed on socket %s ",
447 server
->value
->u
.q_unix
.path
);
449 error_append_hint(errp
, "hint: failed on host %s and port %s ",
450 server
->value
->u
.tcp
.host
,
451 server
->value
->u
.tcp
.port
);
455 error_append_hint(errp
, "Please refer to gluster logs for more info\n");
457 /* glfs_init sometimes doesn't set errno although docs suggest that */
469 glfs_clear_preopened(glfs
);
475 static int qapi_enum_parse(const char *opt
)
480 return GLUSTER_TRANSPORT__MAX
;
483 for (i
= 0; i
< GLUSTER_TRANSPORT__MAX
; i
++) {
484 if (!strcmp(opt
, GlusterTransport_lookup
[i
])) {
493 * Convert the json formatted command line into qapi.
495 static int qemu_gluster_parse_json(BlockdevOptionsGluster
*gconf
,
496 QDict
*options
, Error
**errp
)
499 GlusterServer
*gsconf
;
500 GlusterServerList
*curr
= NULL
;
501 QDict
*backing_options
= NULL
;
502 Error
*local_err
= NULL
;
508 /* create opts info from runtime_json_opts list */
509 opts
= qemu_opts_create(&runtime_json_opts
, NULL
, 0, &error_abort
);
510 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
515 num_servers
= qdict_array_entries(options
, GLUSTER_OPT_SERVER_PATTERN
);
516 if (num_servers
< 1) {
517 error_setg(&local_err
, QERR_MISSING_PARAMETER
, "server");
521 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_VOLUME
);
523 error_setg(&local_err
, QERR_MISSING_PARAMETER
, GLUSTER_OPT_VOLUME
);
526 gconf
->volume
= g_strdup(ptr
);
528 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_PATH
);
530 error_setg(&local_err
, QERR_MISSING_PARAMETER
, GLUSTER_OPT_PATH
);
533 gconf
->path
= g_strdup(ptr
);
536 for (i
= 0; i
< num_servers
; i
++) {
537 str
= g_strdup_printf(GLUSTER_OPT_SERVER_PATTERN
"%d.", i
);
538 qdict_extract_subqdict(options
, &backing_options
, str
);
540 /* create opts info from runtime_type_opts list */
541 opts
= qemu_opts_create(&runtime_type_opts
, NULL
, 0, &error_abort
);
542 qemu_opts_absorb_qdict(opts
, backing_options
, &local_err
);
547 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_TYPE
);
548 gsconf
= g_new0(GlusterServer
, 1);
549 gsconf
->type
= qapi_enum_parse(ptr
);
551 error_setg(&local_err
, QERR_MISSING_PARAMETER
, GLUSTER_OPT_TYPE
);
552 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
556 if (gsconf
->type
== GLUSTER_TRANSPORT__MAX
) {
557 error_setg(&local_err
, QERR_INVALID_PARAMETER_VALUE
,
558 GLUSTER_OPT_TYPE
, "tcp or unix");
559 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
564 if (gsconf
->type
== GLUSTER_TRANSPORT_TCP
) {
565 /* create opts info from runtime_tcp_opts list */
566 opts
= qemu_opts_create(&runtime_tcp_opts
, NULL
, 0, &error_abort
);
567 qemu_opts_absorb_qdict(opts
, backing_options
, &local_err
);
572 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_HOST
);
574 error_setg(&local_err
, QERR_MISSING_PARAMETER
,
576 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
579 gsconf
->u
.tcp
.host
= g_strdup(ptr
);
580 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_PORT
);
582 error_setg(&local_err
, QERR_MISSING_PARAMETER
,
584 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
587 gsconf
->u
.tcp
.port
= g_strdup(ptr
);
589 /* defend for unsupported fields in InetSocketAddress,
590 * i.e. @ipv4, @ipv6 and @to
592 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_TO
);
594 gsconf
->u
.tcp
.has_to
= true;
596 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_IPV4
);
598 gsconf
->u
.tcp
.has_ipv4
= true;
600 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_IPV6
);
602 gsconf
->u
.tcp
.has_ipv6
= true;
604 if (gsconf
->u
.tcp
.has_to
) {
605 error_setg(&local_err
, "Parameter 'to' not supported");
608 if (gsconf
->u
.tcp
.has_ipv4
|| gsconf
->u
.tcp
.has_ipv6
) {
609 error_setg(&local_err
, "Parameters 'ipv4/ipv6' not supported");
614 /* create opts info from runtime_unix_opts list */
615 opts
= qemu_opts_create(&runtime_unix_opts
, NULL
, 0, &error_abort
);
616 qemu_opts_absorb_qdict(opts
, backing_options
, &local_err
);
621 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_SOCKET
);
623 error_setg(&local_err
, QERR_MISSING_PARAMETER
,
625 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
628 gsconf
->u
.q_unix
.path
= g_strdup(ptr
);
632 if (gconf
->server
== NULL
) {
633 gconf
->server
= g_new0(GlusterServerList
, 1);
634 gconf
->server
->value
= gsconf
;
635 curr
= gconf
->server
;
637 curr
->next
= g_new0(GlusterServerList
, 1);
638 curr
->next
->value
= gsconf
;
642 qdict_del(backing_options
, str
);
650 error_propagate(errp
, local_err
);
653 qdict_del(backing_options
, str
);
660 static struct glfs
*qemu_gluster_init(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");
677 ret
= qemu_gluster_parse_json(gconf
, options
, errp
);
679 error_append_hint(errp
, "Usage: "
680 "-drive driver=qcow2,file.driver=gluster,"
681 "file.volume=testvol,file.path=/path/a.qcow2"
683 "[,file.logfile=/path/filename.log],"
684 "file.server.0.type=tcp,"
685 "file.server.0.host=1.2.3.4,"
686 "file.server.0.port=24007,"
687 "file.server.1.transport=unix,"
688 "file.server.1.socket=/var/run/glusterd.socket ..."
696 return qemu_gluster_glfs_init(gconf
, errp
);
700 * AIO callback routine called from GlusterFS thread.
702 static void gluster_finish_aiocb(struct glfs_fd
*fd
, ssize_t ret
, void *arg
)
704 GlusterAIOCB
*acb
= (GlusterAIOCB
*)arg
;
706 if (!ret
|| ret
== acb
->size
) {
707 acb
->ret
= 0; /* Success */
708 } else if (ret
< 0) {
709 acb
->ret
= -errno
; /* Read/Write failed */
711 acb
->ret
= -EIO
; /* Partial read/write - fail it */
714 aio_co_schedule(acb
->aio_context
, acb
->coroutine
);
717 static void qemu_gluster_parse_flags(int bdrv_flags
, int *open_flags
)
719 assert(open_flags
!= NULL
);
721 *open_flags
|= O_BINARY
;
723 if (bdrv_flags
& BDRV_O_RDWR
) {
724 *open_flags
|= O_RDWR
;
726 *open_flags
|= O_RDONLY
;
729 if ((bdrv_flags
& BDRV_O_NOCACHE
)) {
730 *open_flags
|= O_DIRECT
;
735 * Do SEEK_DATA/HOLE to detect if it is functional. Older broken versions of
736 * gfapi incorrectly return the current offset when SEEK_DATA/HOLE is used.
737 * - Corrected versions return -1 and set errno to EINVAL.
738 * - Versions that support SEEK_DATA/HOLE correctly, will return -1 and set
739 * errno to ENXIO when SEEK_DATA is called with a position of EOF.
741 static bool qemu_gluster_test_seek(struct glfs_fd
*fd
)
745 #if defined SEEK_HOLE && defined SEEK_DATA
748 eof
= glfs_lseek(fd
, 0, SEEK_END
);
750 /* this should never occur */
754 /* this should always fail with ENXIO if SEEK_DATA is supported */
755 ret
= glfs_lseek(fd
, eof
, SEEK_DATA
);
758 return (ret
< 0) && (errno
== ENXIO
);
761 static int qemu_gluster_open(BlockDriverState
*bs
, QDict
*options
,
762 int bdrv_flags
, Error
**errp
)
764 BDRVGlusterState
*s
= bs
->opaque
;
767 BlockdevOptionsGluster
*gconf
= NULL
;
769 Error
*local_err
= NULL
;
770 const char *filename
, *logfile
;
772 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
773 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
775 error_propagate(errp
, local_err
);
780 filename
= qemu_opt_get(opts
, GLUSTER_OPT_FILENAME
);
782 s
->debug
= qemu_opt_get_number(opts
, GLUSTER_OPT_DEBUG
,
783 GLUSTER_DEBUG_DEFAULT
);
786 } else if (s
->debug
> GLUSTER_DEBUG_MAX
) {
787 s
->debug
= GLUSTER_DEBUG_MAX
;
790 gconf
= g_new0(BlockdevOptionsGluster
, 1);
791 gconf
->debug
= s
->debug
;
792 gconf
->has_debug
= true;
794 logfile
= qemu_opt_get(opts
, GLUSTER_OPT_LOGFILE
);
795 s
->logfile
= g_strdup(logfile
? logfile
: GLUSTER_LOGFILE_DEFAULT
);
797 gconf
->logfile
= g_strdup(s
->logfile
);
798 gconf
->has_logfile
= true;
800 s
->glfs
= qemu_gluster_init(gconf
, filename
, options
, errp
);
806 #ifdef CONFIG_GLUSTERFS_XLATOR_OPT
807 /* Without this, if fsync fails for a recoverable reason (for instance,
808 * ENOSPC), gluster will dump its cache, preventing retries. This means
809 * almost certain data loss. Not all gluster versions support the
810 * 'resync-failed-syncs-after-fsync' key value, but there is no way to
811 * discover during runtime if it is supported (this api returns success for
812 * unknown key/value pairs) */
813 ret
= glfs_set_xlator_option(s
->glfs
, "*-write-behind",
814 "resync-failed-syncs-after-fsync",
817 error_setg_errno(errp
, errno
, "Unable to set xlator key/value pair");
823 qemu_gluster_parse_flags(bdrv_flags
, &open_flags
);
825 s
->fd
= glfs_open(s
->glfs
, gconf
->path
, open_flags
);
830 s
->supports_seek_data
= qemu_gluster_test_seek(s
->fd
);
834 qapi_free_BlockdevOptionsGluster(gconf
);
843 glfs_clear_preopened(s
->glfs
);
848 static int qemu_gluster_reopen_prepare(BDRVReopenState
*state
,
849 BlockReopenQueue
*queue
, Error
**errp
)
853 BDRVGlusterReopenState
*reop_s
;
854 BlockdevOptionsGluster
*gconf
;
857 assert(state
!= NULL
);
858 assert(state
->bs
!= NULL
);
860 s
= state
->bs
->opaque
;
862 state
->opaque
= g_new0(BDRVGlusterReopenState
, 1);
863 reop_s
= state
->opaque
;
865 qemu_gluster_parse_flags(state
->flags
, &open_flags
);
867 gconf
= g_new0(BlockdevOptionsGluster
, 1);
868 gconf
->debug
= s
->debug
;
869 gconf
->has_debug
= true;
870 gconf
->logfile
= g_strdup(s
->logfile
);
871 gconf
->has_logfile
= true;
872 reop_s
->glfs
= qemu_gluster_init(gconf
, state
->bs
->filename
, NULL
, errp
);
873 if (reop_s
->glfs
== NULL
) {
878 #ifdef CONFIG_GLUSTERFS_XLATOR_OPT
879 ret
= glfs_set_xlator_option(reop_s
->glfs
, "*-write-behind",
880 "resync-failed-syncs-after-fsync", "on");
882 error_setg_errno(errp
, errno
, "Unable to set xlator key/value pair");
888 reop_s
->fd
= glfs_open(reop_s
->glfs
, gconf
->path
, open_flags
);
889 if (reop_s
->fd
== NULL
) {
890 /* reops->glfs will be cleaned up in _abort */
896 /* state->opaque will be freed in either the _abort or _commit */
897 qapi_free_BlockdevOptionsGluster(gconf
);
901 static void qemu_gluster_reopen_commit(BDRVReopenState
*state
)
903 BDRVGlusterReopenState
*reop_s
= state
->opaque
;
904 BDRVGlusterState
*s
= state
->bs
->opaque
;
912 glfs_clear_preopened(s
->glfs
);
914 /* use the newly opened image / connection */
916 s
->glfs
= reop_s
->glfs
;
918 g_free(state
->opaque
);
919 state
->opaque
= NULL
;
925 static void qemu_gluster_reopen_abort(BDRVReopenState
*state
)
927 BDRVGlusterReopenState
*reop_s
= state
->opaque
;
929 if (reop_s
== NULL
) {
934 glfs_close(reop_s
->fd
);
937 glfs_clear_preopened(reop_s
->glfs
);
939 g_free(state
->opaque
);
940 state
->opaque
= NULL
;
945 #ifdef CONFIG_GLUSTERFS_ZEROFILL
946 static coroutine_fn
int qemu_gluster_co_pwrite_zeroes(BlockDriverState
*bs
,
949 BdrvRequestFlags flags
)
953 BDRVGlusterState
*s
= bs
->opaque
;
957 acb
.coroutine
= qemu_coroutine_self();
958 acb
.aio_context
= bdrv_get_aio_context(bs
);
960 ret
= glfs_zerofill_async(s
->fd
, offset
, size
, gluster_finish_aiocb
, &acb
);
965 qemu_coroutine_yield();
969 static inline bool gluster_supports_zerofill(void)
974 static inline int qemu_gluster_zerofill(struct glfs_fd
*fd
, int64_t offset
,
977 return glfs_zerofill(fd
, offset
, size
);
981 static inline bool gluster_supports_zerofill(void)
986 static inline int qemu_gluster_zerofill(struct glfs_fd
*fd
, int64_t offset
,
993 static int qemu_gluster_create(const char *filename
,
994 QemuOpts
*opts
, Error
**errp
)
996 BlockdevOptionsGluster
*gconf
;
1001 int64_t total_size
= 0;
1004 gconf
= g_new0(BlockdevOptionsGluster
, 1);
1005 gconf
->debug
= qemu_opt_get_number_del(opts
, GLUSTER_OPT_DEBUG
,
1006 GLUSTER_DEBUG_DEFAULT
);
1007 if (gconf
->debug
< 0) {
1009 } else if (gconf
->debug
> GLUSTER_DEBUG_MAX
) {
1010 gconf
->debug
= GLUSTER_DEBUG_MAX
;
1012 gconf
->has_debug
= true;
1014 gconf
->logfile
= qemu_opt_get_del(opts
, GLUSTER_OPT_LOGFILE
);
1015 if (!gconf
->logfile
) {
1016 gconf
->logfile
= g_strdup(GLUSTER_LOGFILE_DEFAULT
);
1018 gconf
->has_logfile
= true;
1020 glfs
= qemu_gluster_init(gconf
, filename
, NULL
, errp
);
1026 total_size
= ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
1029 tmp
= qemu_opt_get_del(opts
, BLOCK_OPT_PREALLOC
);
1030 if (!tmp
|| !strcmp(tmp
, "off")) {
1032 } else if (!strcmp(tmp
, "full") && gluster_supports_zerofill()) {
1035 error_setg(errp
, "Invalid preallocation mode: '%s'"
1036 " or GlusterFS doesn't support zerofill API", tmp
);
1041 fd
= glfs_creat(glfs
, gconf
->path
,
1042 O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
, S_IRUSR
| S_IWUSR
);
1046 if (!glfs_ftruncate(fd
, total_size
)) {
1047 if (prealloc
&& qemu_gluster_zerofill(fd
, 0, total_size
)) {
1054 if (glfs_close(fd
) != 0) {
1060 qapi_free_BlockdevOptionsGluster(gconf
);
1061 glfs_clear_preopened(glfs
);
1065 static coroutine_fn
int qemu_gluster_co_rw(BlockDriverState
*bs
,
1066 int64_t sector_num
, int nb_sectors
,
1067 QEMUIOVector
*qiov
, int write
)
1071 BDRVGlusterState
*s
= bs
->opaque
;
1072 size_t size
= nb_sectors
* BDRV_SECTOR_SIZE
;
1073 off_t offset
= sector_num
* BDRV_SECTOR_SIZE
;
1077 acb
.coroutine
= qemu_coroutine_self();
1078 acb
.aio_context
= bdrv_get_aio_context(bs
);
1081 ret
= glfs_pwritev_async(s
->fd
, qiov
->iov
, qiov
->niov
, offset
, 0,
1082 gluster_finish_aiocb
, &acb
);
1084 ret
= glfs_preadv_async(s
->fd
, qiov
->iov
, qiov
->niov
, offset
, 0,
1085 gluster_finish_aiocb
, &acb
);
1092 qemu_coroutine_yield();
1096 static int qemu_gluster_truncate(BlockDriverState
*bs
, int64_t offset
)
1099 BDRVGlusterState
*s
= bs
->opaque
;
1101 ret
= glfs_ftruncate(s
->fd
, offset
);
1109 static coroutine_fn
int qemu_gluster_co_readv(BlockDriverState
*bs
,
1114 return qemu_gluster_co_rw(bs
, sector_num
, nb_sectors
, qiov
, 0);
1117 static coroutine_fn
int qemu_gluster_co_writev(BlockDriverState
*bs
,
1122 return qemu_gluster_co_rw(bs
, sector_num
, nb_sectors
, qiov
, 1);
1125 static void qemu_gluster_close(BlockDriverState
*bs
)
1127 BDRVGlusterState
*s
= bs
->opaque
;
1134 glfs_clear_preopened(s
->glfs
);
1137 static coroutine_fn
int qemu_gluster_co_flush_to_disk(BlockDriverState
*bs
)
1141 BDRVGlusterState
*s
= bs
->opaque
;
1145 acb
.coroutine
= qemu_coroutine_self();
1146 acb
.aio_context
= bdrv_get_aio_context(bs
);
1148 ret
= glfs_fsync_async(s
->fd
, gluster_finish_aiocb
, &acb
);
1154 qemu_coroutine_yield();
1163 /* Some versions of Gluster (3.5.6 -> 3.5.8?) will not retain its cache
1164 * after a fsync failure, so we have no way of allowing the guest to safely
1165 * continue. Gluster versions prior to 3.5.6 don't retain the cache
1166 * either, but will invalidate the fd on error, so this is again our only
1169 * The 'resync-failed-syncs-after-fsync' xlator option for the
1170 * write-behind cache will cause later gluster versions to retain its
1171 * cache after error, so long as the fd remains open. However, we
1172 * currently have no way of knowing if this option is supported.
1174 * TODO: Once gluster provides a way for us to determine if the option
1175 * is supported, bypass the closure and setting drv to NULL. */
1176 qemu_gluster_close(bs
);
1181 #ifdef CONFIG_GLUSTERFS_DISCARD
1182 static coroutine_fn
int qemu_gluster_co_pdiscard(BlockDriverState
*bs
,
1183 int64_t offset
, int size
)
1187 BDRVGlusterState
*s
= bs
->opaque
;
1191 acb
.coroutine
= qemu_coroutine_self();
1192 acb
.aio_context
= bdrv_get_aio_context(bs
);
1194 ret
= glfs_discard_async(s
->fd
, offset
, size
, gluster_finish_aiocb
, &acb
);
1199 qemu_coroutine_yield();
1204 static int64_t qemu_gluster_getlength(BlockDriverState
*bs
)
1206 BDRVGlusterState
*s
= bs
->opaque
;
1209 ret
= glfs_lseek(s
->fd
, 0, SEEK_END
);
1217 static int64_t qemu_gluster_allocated_file_size(BlockDriverState
*bs
)
1219 BDRVGlusterState
*s
= bs
->opaque
;
1223 ret
= glfs_fstat(s
->fd
, &st
);
1227 return st
.st_blocks
* 512;
1231 static int qemu_gluster_has_zero_init(BlockDriverState
*bs
)
1233 /* GlusterFS volume could be backed by a block device */
1238 * Find allocation range in @bs around offset @start.
1239 * May change underlying file descriptor's file offset.
1240 * If @start is not in a hole, store @start in @data, and the
1241 * beginning of the next hole in @hole, and return 0.
1242 * If @start is in a non-trailing hole, store @start in @hole and the
1243 * beginning of the next non-hole in @data, and return 0.
1244 * If @start is in a trailing hole or beyond EOF, return -ENXIO.
1245 * If we can't find out, return a negative errno other than -ENXIO.
1247 * (Shamefully copied from file-posix.c, only miniscule adaptions.)
1249 static int find_allocation(BlockDriverState
*bs
, off_t start
,
1250 off_t
*data
, off_t
*hole
)
1252 BDRVGlusterState
*s
= bs
->opaque
;
1254 if (!s
->supports_seek_data
) {
1258 #if defined SEEK_HOLE && defined SEEK_DATA
1263 * D1. offs == start: start is in data
1264 * D2. offs > start: start is in a hole, next data at offs
1265 * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
1266 * or start is beyond EOF
1267 * If the latter happens, the file has been truncated behind
1268 * our back since we opened it. All bets are off then.
1269 * Treating like a trailing hole is simplest.
1270 * D4. offs < 0, errno != ENXIO: we learned nothing
1272 offs
= glfs_lseek(s
->fd
, start
, SEEK_DATA
);
1274 return -errno
; /* D3 or D4 */
1276 assert(offs
>= start
);
1279 /* D2: in hole, next data at offs */
1285 /* D1: in data, end not yet known */
1289 * H1. offs == start: start is in a hole
1290 * If this happens here, a hole has been dug behind our back
1291 * since the previous lseek().
1292 * H2. offs > start: either start is in data, next hole at offs,
1293 * or start is in trailing hole, EOF at offs
1294 * Linux treats trailing holes like any other hole: offs ==
1295 * start. Solaris seeks to EOF instead: offs > start (blech).
1296 * If that happens here, a hole has been dug behind our back
1297 * since the previous lseek().
1298 * H3. offs < 0, errno = ENXIO: start is beyond EOF
1299 * If this happens, the file has been truncated behind our
1300 * back since we opened it. Treat it like a trailing hole.
1301 * H4. offs < 0, errno != ENXIO: we learned nothing
1302 * Pretend we know nothing at all, i.e. "forget" about D1.
1304 offs
= glfs_lseek(s
->fd
, start
, SEEK_HOLE
);
1306 return -errno
; /* D1 and (H3 or H4) */
1308 assert(offs
>= start
);
1312 * D1 and H2: either in data, next hole at offs, or it was in
1313 * data but is now in a trailing hole. In the latter case,
1314 * all bets are off. Treating it as if it there was data all
1315 * the way to EOF is safe, so simply do that.
1331 * Returns the allocation status of the specified sectors.
1333 * If 'sector_num' is beyond the end of the disk image the return value is 0
1334 * and 'pnum' is set to 0.
1336 * 'pnum' is set to the number of sectors (including and immediately following
1337 * the specified sector) that are known to be in the same
1338 * allocated/unallocated state.
1340 * 'nb_sectors' is the max value 'pnum' should be set to. If nb_sectors goes
1341 * beyond the end of the disk image it will be clamped.
1343 * (Based on raw_co_get_block_status() from file-posix.c.)
1345 static int64_t coroutine_fn
qemu_gluster_co_get_block_status(
1346 BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
, int *pnum
,
1347 BlockDriverState
**file
)
1349 BDRVGlusterState
*s
= bs
->opaque
;
1350 off_t start
, data
= 0, hole
= 0;
1358 start
= sector_num
* BDRV_SECTOR_SIZE
;
1359 total_size
= bdrv_getlength(bs
);
1360 if (total_size
< 0) {
1362 } else if (start
>= total_size
) {
1365 } else if (start
+ nb_sectors
* BDRV_SECTOR_SIZE
> total_size
) {
1366 nb_sectors
= DIV_ROUND_UP(total_size
- start
, BDRV_SECTOR_SIZE
);
1369 ret
= find_allocation(bs
, start
, &data
, &hole
);
1370 if (ret
== -ENXIO
) {
1373 ret
= BDRV_BLOCK_ZERO
;
1374 } else if (ret
< 0) {
1375 /* No info available, so pretend there are no holes */
1377 ret
= BDRV_BLOCK_DATA
;
1378 } else if (data
== start
) {
1379 /* On a data extent, compute sectors to the end of the extent,
1380 * possibly including a partial sector at EOF. */
1381 *pnum
= MIN(nb_sectors
, DIV_ROUND_UP(hole
- start
, BDRV_SECTOR_SIZE
));
1382 ret
= BDRV_BLOCK_DATA
;
1384 /* On a hole, compute sectors to the beginning of the next extent. */
1385 assert(hole
== start
);
1386 *pnum
= MIN(nb_sectors
, (data
- start
) / BDRV_SECTOR_SIZE
);
1387 ret
= BDRV_BLOCK_ZERO
;
1392 return ret
| BDRV_BLOCK_OFFSET_VALID
| start
;
1396 static BlockDriver bdrv_gluster
= {
1397 .format_name
= "gluster",
1398 .protocol_name
= "gluster",
1399 .instance_size
= sizeof(BDRVGlusterState
),
1400 .bdrv_needs_filename
= false,
1401 .bdrv_file_open
= qemu_gluster_open
,
1402 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1403 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1404 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1405 .bdrv_close
= qemu_gluster_close
,
1406 .bdrv_create
= qemu_gluster_create
,
1407 .bdrv_getlength
= qemu_gluster_getlength
,
1408 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1409 .bdrv_truncate
= qemu_gluster_truncate
,
1410 .bdrv_co_readv
= qemu_gluster_co_readv
,
1411 .bdrv_co_writev
= qemu_gluster_co_writev
,
1412 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1413 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1414 #ifdef CONFIG_GLUSTERFS_DISCARD
1415 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1417 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1418 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1420 .bdrv_co_get_block_status
= qemu_gluster_co_get_block_status
,
1421 .create_opts
= &qemu_gluster_create_opts
,
1424 static BlockDriver bdrv_gluster_tcp
= {
1425 .format_name
= "gluster",
1426 .protocol_name
= "gluster+tcp",
1427 .instance_size
= sizeof(BDRVGlusterState
),
1428 .bdrv_needs_filename
= false,
1429 .bdrv_file_open
= qemu_gluster_open
,
1430 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1431 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1432 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1433 .bdrv_close
= qemu_gluster_close
,
1434 .bdrv_create
= qemu_gluster_create
,
1435 .bdrv_getlength
= qemu_gluster_getlength
,
1436 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1437 .bdrv_truncate
= qemu_gluster_truncate
,
1438 .bdrv_co_readv
= qemu_gluster_co_readv
,
1439 .bdrv_co_writev
= qemu_gluster_co_writev
,
1440 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1441 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1442 #ifdef CONFIG_GLUSTERFS_DISCARD
1443 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1445 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1446 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1448 .bdrv_co_get_block_status
= qemu_gluster_co_get_block_status
,
1449 .create_opts
= &qemu_gluster_create_opts
,
1452 static BlockDriver bdrv_gluster_unix
= {
1453 .format_name
= "gluster",
1454 .protocol_name
= "gluster+unix",
1455 .instance_size
= sizeof(BDRVGlusterState
),
1456 .bdrv_needs_filename
= true,
1457 .bdrv_file_open
= qemu_gluster_open
,
1458 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1459 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1460 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1461 .bdrv_close
= qemu_gluster_close
,
1462 .bdrv_create
= qemu_gluster_create
,
1463 .bdrv_getlength
= qemu_gluster_getlength
,
1464 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1465 .bdrv_truncate
= qemu_gluster_truncate
,
1466 .bdrv_co_readv
= qemu_gluster_co_readv
,
1467 .bdrv_co_writev
= qemu_gluster_co_writev
,
1468 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1469 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1470 #ifdef CONFIG_GLUSTERFS_DISCARD
1471 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1473 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1474 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1476 .bdrv_co_get_block_status
= qemu_gluster_co_get_block_status
,
1477 .create_opts
= &qemu_gluster_create_opts
,
1480 /* rdma is deprecated (actually never supported for volfile fetch).
1481 * Let's maintain it for the protocol compatibility, to make sure things
1482 * won't break immediately. For now, gluster+rdma will fall back to gluster+tcp
1483 * protocol with a warning.
1484 * TODO: remove gluster+rdma interface support
1486 static BlockDriver bdrv_gluster_rdma
= {
1487 .format_name
= "gluster",
1488 .protocol_name
= "gluster+rdma",
1489 .instance_size
= sizeof(BDRVGlusterState
),
1490 .bdrv_needs_filename
= true,
1491 .bdrv_file_open
= qemu_gluster_open
,
1492 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1493 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1494 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1495 .bdrv_close
= qemu_gluster_close
,
1496 .bdrv_create
= qemu_gluster_create
,
1497 .bdrv_getlength
= qemu_gluster_getlength
,
1498 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1499 .bdrv_truncate
= qemu_gluster_truncate
,
1500 .bdrv_co_readv
= qemu_gluster_co_readv
,
1501 .bdrv_co_writev
= qemu_gluster_co_writev
,
1502 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1503 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1504 #ifdef CONFIG_GLUSTERFS_DISCARD
1505 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1507 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1508 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1510 .bdrv_co_get_block_status
= qemu_gluster_co_get_block_status
,
1511 .create_opts
= &qemu_gluster_create_opts
,
1514 static void bdrv_gluster_init(void)
1516 bdrv_register(&bdrv_gluster_rdma
);
1517 bdrv_register(&bdrv_gluster_unix
);
1518 bdrv_register(&bdrv_gluster_tcp
);
1519 bdrv_register(&bdrv_gluster
);
1522 block_init(bdrv_gluster_init
);