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"
15 #include "qapi/util.h"
17 #include "qemu/error-report.h"
18 #include "qemu/cutils.h"
20 #define GLUSTER_OPT_FILENAME "filename"
21 #define GLUSTER_OPT_VOLUME "volume"
22 #define GLUSTER_OPT_PATH "path"
23 #define GLUSTER_OPT_TYPE "type"
24 #define GLUSTER_OPT_SERVER_PATTERN "server."
25 #define GLUSTER_OPT_HOST "host"
26 #define GLUSTER_OPT_PORT "port"
27 #define GLUSTER_OPT_TO "to"
28 #define GLUSTER_OPT_IPV4 "ipv4"
29 #define GLUSTER_OPT_IPV6 "ipv6"
30 #define GLUSTER_OPT_SOCKET "socket"
31 #define GLUSTER_OPT_DEBUG "debug"
32 #define GLUSTER_DEFAULT_PORT 24007
33 #define GLUSTER_DEBUG_DEFAULT 4
34 #define GLUSTER_DEBUG_MAX 9
35 #define GLUSTER_OPT_LOGFILE "logfile"
36 #define GLUSTER_LOGFILE_DEFAULT "-" /* handled in libgfapi as /dev/stderr */
38 #define GERR_INDEX_HINT "hint: check in 'server' array index '%d'\n"
40 typedef struct GlusterAIOCB
{
44 AioContext
*aio_context
;
47 typedef struct BDRVGlusterState
{
51 bool supports_seek_data
;
55 typedef struct BDRVGlusterReopenState
{
58 } BDRVGlusterReopenState
;
61 typedef struct GlfsPreopened
{
67 typedef struct ListElement
{
68 QLIST_ENTRY(ListElement
) list
;
72 static QLIST_HEAD(glfs_list
, ListElement
) glfs_list
;
74 static QemuOptsList qemu_gluster_create_opts
= {
75 .name
= "qemu-gluster-create-opts",
76 .head
= QTAILQ_HEAD_INITIALIZER(qemu_gluster_create_opts
.head
),
79 .name
= BLOCK_OPT_SIZE
,
80 .type
= QEMU_OPT_SIZE
,
81 .help
= "Virtual disk size"
84 .name
= BLOCK_OPT_PREALLOC
,
85 .type
= QEMU_OPT_STRING
,
86 .help
= "Preallocation mode (allowed values: off, full)"
89 .name
= GLUSTER_OPT_DEBUG
,
90 .type
= QEMU_OPT_NUMBER
,
91 .help
= "Gluster log level, valid range is 0-9",
94 .name
= GLUSTER_OPT_LOGFILE
,
95 .type
= QEMU_OPT_STRING
,
96 .help
= "Logfile path of libgfapi",
102 static QemuOptsList runtime_opts
= {
104 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
107 .name
= GLUSTER_OPT_FILENAME
,
108 .type
= QEMU_OPT_STRING
,
109 .help
= "URL to the gluster image",
112 .name
= GLUSTER_OPT_DEBUG
,
113 .type
= QEMU_OPT_NUMBER
,
114 .help
= "Gluster log level, valid range is 0-9",
117 .name
= GLUSTER_OPT_LOGFILE
,
118 .type
= QEMU_OPT_STRING
,
119 .help
= "Logfile path of libgfapi",
121 { /* end of list */ }
125 static QemuOptsList runtime_json_opts
= {
126 .name
= "gluster_json",
127 .head
= QTAILQ_HEAD_INITIALIZER(runtime_json_opts
.head
),
130 .name
= GLUSTER_OPT_VOLUME
,
131 .type
= QEMU_OPT_STRING
,
132 .help
= "name of gluster volume where VM image resides",
135 .name
= GLUSTER_OPT_PATH
,
136 .type
= QEMU_OPT_STRING
,
137 .help
= "absolute path to image file in gluster volume",
140 .name
= GLUSTER_OPT_DEBUG
,
141 .type
= QEMU_OPT_NUMBER
,
142 .help
= "Gluster log level, valid range is 0-9",
144 { /* end of list */ }
148 static QemuOptsList runtime_type_opts
= {
149 .name
= "gluster_type",
150 .head
= QTAILQ_HEAD_INITIALIZER(runtime_type_opts
.head
),
153 .name
= GLUSTER_OPT_TYPE
,
154 .type
= QEMU_OPT_STRING
,
157 { /* end of list */ }
161 static QemuOptsList runtime_unix_opts
= {
162 .name
= "gluster_unix",
163 .head
= QTAILQ_HEAD_INITIALIZER(runtime_unix_opts
.head
),
166 .name
= GLUSTER_OPT_SOCKET
,
167 .type
= QEMU_OPT_STRING
,
168 .help
= "socket file path)",
170 { /* end of list */ }
174 static QemuOptsList runtime_inet_opts
= {
175 .name
= "gluster_inet",
176 .head
= QTAILQ_HEAD_INITIALIZER(runtime_inet_opts
.head
),
179 .name
= GLUSTER_OPT_TYPE
,
180 .type
= QEMU_OPT_STRING
,
184 .name
= GLUSTER_OPT_HOST
,
185 .type
= QEMU_OPT_STRING
,
186 .help
= "host address (hostname/ipv4/ipv6 addresses)",
189 .name
= GLUSTER_OPT_PORT
,
190 .type
= QEMU_OPT_STRING
,
191 .help
= "port number on which glusterd is listening (default 24007)",
195 .type
= QEMU_OPT_NUMBER
,
196 .help
= "max port number, not supported by gluster",
200 .type
= QEMU_OPT_BOOL
,
201 .help
= "ipv4 bool value, not supported by gluster",
205 .type
= QEMU_OPT_BOOL
,
206 .help
= "ipv6 bool value, not supported by gluster",
208 { /* end of list */ }
212 static void glfs_set_preopened(const char *volume
, glfs_t
*fs
)
214 ListElement
*entry
= NULL
;
216 entry
= g_new(ListElement
, 1);
218 entry
->saved
.volume
= g_strdup(volume
);
220 entry
->saved
.fs
= fs
;
221 entry
->saved
.ref
= 1;
223 QLIST_INSERT_HEAD(&glfs_list
, entry
, list
);
226 static glfs_t
*glfs_find_preopened(const char *volume
)
228 ListElement
*entry
= NULL
;
230 QLIST_FOREACH(entry
, &glfs_list
, list
) {
231 if (strcmp(entry
->saved
.volume
, volume
) == 0) {
233 return entry
->saved
.fs
;
240 static void glfs_clear_preopened(glfs_t
*fs
)
242 ListElement
*entry
= NULL
;
249 QLIST_FOREACH_SAFE(entry
, &glfs_list
, list
, next
) {
250 if (entry
->saved
.fs
== fs
) {
251 if (--entry
->saved
.ref
) {
255 QLIST_REMOVE(entry
, list
);
257 glfs_fini(entry
->saved
.fs
);
258 g_free(entry
->saved
.volume
);
264 static int parse_volume_options(BlockdevOptionsGluster
*gconf
, char *path
)
273 p
= q
= path
+ strspn(path
, "/");
274 p
+= strcspn(p
, "/");
278 gconf
->volume
= g_strndup(q
, p
- q
);
285 gconf
->path
= g_strdup(p
);
290 * file=gluster[+transport]://[host[:port]]/volume/path[?socket=...]
292 * 'gluster' is the protocol.
294 * 'transport' specifies the transport type used to connect to gluster
295 * management daemon (glusterd). Valid transport types are
296 * tcp or unix. If a transport type isn't specified, then tcp type is assumed.
298 * 'host' specifies the host where the volume file specification for
299 * the given volume resides. This can be either hostname or ipv4 address.
300 * If transport type is 'unix', then 'host' field should not be specified.
301 * The 'socket' field needs to be populated with the path to unix domain
304 * 'port' is the port number on which glusterd is listening. This is optional
305 * and if not specified, QEMU will send 0 which will make gluster to use the
306 * default port. If the transport type is unix, then 'port' should not be
309 * 'volume' is the name of the gluster volume which contains the VM image.
311 * 'path' is the path to the actual VM image that resides on gluster volume.
315 * file=gluster://1.2.3.4/testvol/a.img
316 * file=gluster+tcp://1.2.3.4/testvol/a.img
317 * file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
318 * file=gluster+tcp://host.domain.com:24007/testvol/dir/a.img
319 * file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
321 static int qemu_gluster_parse_uri(BlockdevOptionsGluster
*gconf
,
322 const char *filename
)
324 SocketAddressFlat
*gsconf
;
326 QueryParams
*qp
= NULL
;
327 bool is_unix
= false;
330 uri
= uri_parse(filename
);
335 gconf
->server
= g_new0(SocketAddressFlatList
, 1);
336 gconf
->server
->value
= gsconf
= g_new0(SocketAddressFlat
, 1);
339 if (!uri
->scheme
|| !strcmp(uri
->scheme
, "gluster")) {
340 gsconf
->type
= SOCKET_ADDRESS_FLAT_TYPE_INET
;
341 } else if (!strcmp(uri
->scheme
, "gluster+tcp")) {
342 gsconf
->type
= SOCKET_ADDRESS_FLAT_TYPE_INET
;
343 } else if (!strcmp(uri
->scheme
, "gluster+unix")) {
344 gsconf
->type
= SOCKET_ADDRESS_FLAT_TYPE_UNIX
;
346 } else if (!strcmp(uri
->scheme
, "gluster+rdma")) {
347 gsconf
->type
= SOCKET_ADDRESS_FLAT_TYPE_INET
;
348 error_report("Warning: rdma feature is not supported, falling "
355 ret
= parse_volume_options(gconf
, uri
->path
);
360 qp
= query_params_parse(uri
->query
);
361 if (qp
->n
> 1 || (is_unix
&& !qp
->n
) || (!is_unix
&& qp
->n
)) {
367 if (uri
->server
|| uri
->port
) {
371 if (strcmp(qp
->p
[0].name
, "socket")) {
375 gsconf
->u
.q_unix
.path
= g_strdup(qp
->p
[0].value
);
377 gsconf
->u
.inet
.host
= g_strdup(uri
->server
? uri
->server
: "localhost");
379 gsconf
->u
.inet
.port
= g_strdup_printf("%d", uri
->port
);
381 gsconf
->u
.inet
.port
= g_strdup_printf("%d", GLUSTER_DEFAULT_PORT
);
387 query_params_free(qp
);
393 static struct glfs
*qemu_gluster_glfs_init(BlockdevOptionsGluster
*gconf
,
399 SocketAddressFlatList
*server
;
400 unsigned long long port
;
402 glfs
= glfs_find_preopened(gconf
->volume
);
407 glfs
= glfs_new(gconf
->volume
);
412 glfs_set_preopened(gconf
->volume
, glfs
);
414 for (server
= gconf
->server
; server
; server
= server
->next
) {
415 switch (server
->value
->type
) {
416 case SOCKET_ADDRESS_FLAT_TYPE_UNIX
:
417 ret
= glfs_set_volfile_server(glfs
, "unix",
418 server
->value
->u
.q_unix
.path
, 0);
420 case SOCKET_ADDRESS_FLAT_TYPE_INET
:
421 if (parse_uint_full(server
->value
->u
.inet
.port
, &port
, 10) < 0 ||
423 error_setg(errp
, "'%s' is not a valid port number",
424 server
->value
->u
.inet
.port
);
428 ret
= glfs_set_volfile_server(glfs
, "tcp",
429 server
->value
->u
.inet
.host
,
432 case SOCKET_ADDRESS_FLAT_TYPE_VSOCK
:
433 case SOCKET_ADDRESS_FLAT_TYPE_FD
:
443 ret
= glfs_set_logging(glfs
, gconf
->logfile
, gconf
->debug
);
448 ret
= glfs_init(glfs
);
450 error_setg(errp
, "Gluster connection for volume %s, path %s failed"
451 " to connect", gconf
->volume
, gconf
->path
);
452 for (server
= gconf
->server
; server
; server
= server
->next
) {
453 if (server
->value
->type
== SOCKET_ADDRESS_FLAT_TYPE_UNIX
) {
454 error_append_hint(errp
, "hint: failed on socket %s ",
455 server
->value
->u
.q_unix
.path
);
457 error_append_hint(errp
, "hint: failed on host %s and port %s ",
458 server
->value
->u
.inet
.host
,
459 server
->value
->u
.inet
.port
);
463 error_append_hint(errp
, "Please refer to gluster logs for more info\n");
465 /* glfs_init sometimes doesn't set errno although docs suggest that */
477 glfs_clear_preopened(glfs
);
484 * Convert the json formatted command line into qapi.
486 static int qemu_gluster_parse_json(BlockdevOptionsGluster
*gconf
,
487 QDict
*options
, Error
**errp
)
490 SocketAddressFlat
*gsconf
= NULL
;
491 SocketAddressFlatList
*curr
= NULL
;
492 QDict
*backing_options
= NULL
;
493 Error
*local_err
= NULL
;
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(SocketAddressFlat
, 1);
546 if (!strcmp(ptr
, "tcp")) {
547 ptr
= "inet"; /* accept legacy "tcp" */
549 type
= qapi_enum_parse(SocketAddressFlatType_lookup
, ptr
,
550 SOCKET_ADDRESS_FLAT_TYPE__MAX
, -1, NULL
);
551 if (type
!= SOCKET_ADDRESS_FLAT_TYPE_INET
552 && type
!= SOCKET_ADDRESS_FLAT_TYPE_UNIX
) {
553 error_setg(&local_err
,
554 "Parameter '%s' may be 'inet' or 'unix'",
556 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
562 if (gsconf
->type
== SOCKET_ADDRESS_FLAT_TYPE_INET
) {
563 /* create opts info from runtime_inet_opts list */
564 opts
= qemu_opts_create(&runtime_inet_opts
, NULL
, 0, &error_abort
);
565 qemu_opts_absorb_qdict(opts
, backing_options
, &local_err
);
570 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_HOST
);
572 error_setg(&local_err
, QERR_MISSING_PARAMETER
,
574 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
577 gsconf
->u
.inet
.host
= g_strdup(ptr
);
578 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_PORT
);
580 error_setg(&local_err
, QERR_MISSING_PARAMETER
,
582 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
585 gsconf
->u
.inet
.port
= g_strdup(ptr
);
587 /* defend for unsupported fields in InetSocketAddress,
588 * i.e. @ipv4, @ipv6 and @to
590 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_TO
);
592 gsconf
->u
.inet
.has_to
= true;
594 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_IPV4
);
596 gsconf
->u
.inet
.has_ipv4
= true;
598 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_IPV6
);
600 gsconf
->u
.inet
.has_ipv6
= true;
602 if (gsconf
->u
.inet
.has_to
) {
603 error_setg(&local_err
, "Parameter 'to' not supported");
606 if (gsconf
->u
.inet
.has_ipv4
|| gsconf
->u
.inet
.has_ipv6
) {
607 error_setg(&local_err
, "Parameters 'ipv4/ipv6' not supported");
612 /* create opts info from runtime_unix_opts list */
613 opts
= qemu_opts_create(&runtime_unix_opts
, NULL
, 0, &error_abort
);
614 qemu_opts_absorb_qdict(opts
, backing_options
, &local_err
);
619 ptr
= qemu_opt_get(opts
, GLUSTER_OPT_SOCKET
);
621 error_setg(&local_err
, QERR_MISSING_PARAMETER
,
623 error_append_hint(&local_err
, GERR_INDEX_HINT
, i
);
626 gsconf
->u
.q_unix
.path
= g_strdup(ptr
);
630 if (gconf
->server
== NULL
) {
631 gconf
->server
= g_new0(SocketAddressFlatList
, 1);
632 gconf
->server
->value
= gsconf
;
633 curr
= gconf
->server
;
635 curr
->next
= g_new0(SocketAddressFlatList
, 1);
636 curr
->next
->value
= gsconf
;
641 QDECREF(backing_options
);
642 backing_options
= NULL
;
650 error_propagate(errp
, local_err
);
651 qapi_free_SocketAddressFlat(gsconf
);
654 QDECREF(backing_options
);
659 static struct glfs
*qemu_gluster_init(BlockdevOptionsGluster
*gconf
,
660 const char *filename
,
661 QDict
*options
, Error
**errp
)
665 ret
= qemu_gluster_parse_uri(gconf
, filename
);
667 error_setg(errp
, "invalid URI");
668 error_append_hint(errp
, "Usage: file=gluster[+transport]://"
669 "[host[:port]]volume/path[?socket=...]"
671 "[,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 ..."
695 return qemu_gluster_glfs_init(gconf
, errp
);
699 * AIO callback routine called from GlusterFS thread.
701 static void gluster_finish_aiocb(struct glfs_fd
*fd
, ssize_t ret
, void *arg
)
703 GlusterAIOCB
*acb
= (GlusterAIOCB
*)arg
;
705 if (!ret
|| ret
== acb
->size
) {
706 acb
->ret
= 0; /* Success */
707 } else if (ret
< 0) {
708 acb
->ret
= -errno
; /* Read/Write failed */
710 acb
->ret
= -EIO
; /* Partial read/write - fail it */
713 aio_co_schedule(acb
->aio_context
, acb
->coroutine
);
716 static void qemu_gluster_parse_flags(int bdrv_flags
, int *open_flags
)
718 assert(open_flags
!= NULL
);
720 *open_flags
|= O_BINARY
;
722 if (bdrv_flags
& BDRV_O_RDWR
) {
723 *open_flags
|= O_RDWR
;
725 *open_flags
|= O_RDONLY
;
728 if ((bdrv_flags
& BDRV_O_NOCACHE
)) {
729 *open_flags
|= O_DIRECT
;
734 * Do SEEK_DATA/HOLE to detect if it is functional. Older broken versions of
735 * gfapi incorrectly return the current offset when SEEK_DATA/HOLE is used.
736 * - Corrected versions return -1 and set errno to EINVAL.
737 * - Versions that support SEEK_DATA/HOLE correctly, will return -1 and set
738 * errno to ENXIO when SEEK_DATA is called with a position of EOF.
740 static bool qemu_gluster_test_seek(struct glfs_fd
*fd
)
744 #if defined SEEK_HOLE && defined SEEK_DATA
747 eof
= glfs_lseek(fd
, 0, SEEK_END
);
749 /* this should never occur */
753 /* this should always fail with ENXIO if SEEK_DATA is supported */
754 ret
= glfs_lseek(fd
, eof
, SEEK_DATA
);
757 return (ret
< 0) && (errno
== ENXIO
);
760 static int qemu_gluster_open(BlockDriverState
*bs
, QDict
*options
,
761 int bdrv_flags
, Error
**errp
)
763 BDRVGlusterState
*s
= bs
->opaque
;
766 BlockdevOptionsGluster
*gconf
= NULL
;
768 Error
*local_err
= NULL
;
769 const char *filename
, *logfile
;
771 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
772 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
774 error_propagate(errp
, local_err
);
779 filename
= qemu_opt_get(opts
, GLUSTER_OPT_FILENAME
);
781 s
->debug
= qemu_opt_get_number(opts
, GLUSTER_OPT_DEBUG
,
782 GLUSTER_DEBUG_DEFAULT
);
785 } else if (s
->debug
> GLUSTER_DEBUG_MAX
) {
786 s
->debug
= GLUSTER_DEBUG_MAX
;
789 gconf
= g_new0(BlockdevOptionsGluster
, 1);
790 gconf
->debug
= s
->debug
;
791 gconf
->has_debug
= true;
793 logfile
= qemu_opt_get(opts
, GLUSTER_OPT_LOGFILE
);
794 s
->logfile
= g_strdup(logfile
? logfile
: GLUSTER_LOGFILE_DEFAULT
);
796 gconf
->logfile
= g_strdup(s
->logfile
);
797 gconf
->has_logfile
= true;
799 s
->glfs
= qemu_gluster_init(gconf
, filename
, options
, errp
);
805 #ifdef CONFIG_GLUSTERFS_XLATOR_OPT
806 /* Without this, if fsync fails for a recoverable reason (for instance,
807 * ENOSPC), gluster will dump its cache, preventing retries. This means
808 * almost certain data loss. Not all gluster versions support the
809 * 'resync-failed-syncs-after-fsync' key value, but there is no way to
810 * discover during runtime if it is supported (this api returns success for
811 * unknown key/value pairs) */
812 ret
= glfs_set_xlator_option(s
->glfs
, "*-write-behind",
813 "resync-failed-syncs-after-fsync",
816 error_setg_errno(errp
, errno
, "Unable to set xlator key/value pair");
822 qemu_gluster_parse_flags(bdrv_flags
, &open_flags
);
824 s
->fd
= glfs_open(s
->glfs
, gconf
->path
, open_flags
);
829 s
->supports_seek_data
= qemu_gluster_test_seek(s
->fd
);
833 qapi_free_BlockdevOptionsGluster(gconf
);
842 glfs_clear_preopened(s
->glfs
);
847 static int qemu_gluster_reopen_prepare(BDRVReopenState
*state
,
848 BlockReopenQueue
*queue
, Error
**errp
)
852 BDRVGlusterReopenState
*reop_s
;
853 BlockdevOptionsGluster
*gconf
;
856 assert(state
!= NULL
);
857 assert(state
->bs
!= NULL
);
859 s
= state
->bs
->opaque
;
861 state
->opaque
= g_new0(BDRVGlusterReopenState
, 1);
862 reop_s
= state
->opaque
;
864 qemu_gluster_parse_flags(state
->flags
, &open_flags
);
866 gconf
= g_new0(BlockdevOptionsGluster
, 1);
867 gconf
->debug
= s
->debug
;
868 gconf
->has_debug
= true;
869 gconf
->logfile
= g_strdup(s
->logfile
);
870 gconf
->has_logfile
= true;
871 reop_s
->glfs
= qemu_gluster_init(gconf
, state
->bs
->filename
, NULL
, errp
);
872 if (reop_s
->glfs
== NULL
) {
877 #ifdef CONFIG_GLUSTERFS_XLATOR_OPT
878 ret
= glfs_set_xlator_option(reop_s
->glfs
, "*-write-behind",
879 "resync-failed-syncs-after-fsync", "on");
881 error_setg_errno(errp
, errno
, "Unable to set xlator key/value pair");
887 reop_s
->fd
= glfs_open(reop_s
->glfs
, gconf
->path
, open_flags
);
888 if (reop_s
->fd
== NULL
) {
889 /* reops->glfs will be cleaned up in _abort */
895 /* state->opaque will be freed in either the _abort or _commit */
896 qapi_free_BlockdevOptionsGluster(gconf
);
900 static void qemu_gluster_reopen_commit(BDRVReopenState
*state
)
902 BDRVGlusterReopenState
*reop_s
= state
->opaque
;
903 BDRVGlusterState
*s
= state
->bs
->opaque
;
911 glfs_clear_preopened(s
->glfs
);
913 /* use the newly opened image / connection */
915 s
->glfs
= reop_s
->glfs
;
917 g_free(state
->opaque
);
918 state
->opaque
= NULL
;
924 static void qemu_gluster_reopen_abort(BDRVReopenState
*state
)
926 BDRVGlusterReopenState
*reop_s
= state
->opaque
;
928 if (reop_s
== NULL
) {
933 glfs_close(reop_s
->fd
);
936 glfs_clear_preopened(reop_s
->glfs
);
938 g_free(state
->opaque
);
939 state
->opaque
= NULL
;
944 #ifdef CONFIG_GLUSTERFS_ZEROFILL
945 static coroutine_fn
int qemu_gluster_co_pwrite_zeroes(BlockDriverState
*bs
,
948 BdrvRequestFlags flags
)
952 BDRVGlusterState
*s
= bs
->opaque
;
956 acb
.coroutine
= qemu_coroutine_self();
957 acb
.aio_context
= bdrv_get_aio_context(bs
);
959 ret
= glfs_zerofill_async(s
->fd
, offset
, size
, gluster_finish_aiocb
, &acb
);
964 qemu_coroutine_yield();
968 static inline bool gluster_supports_zerofill(void)
973 static inline int qemu_gluster_zerofill(struct glfs_fd
*fd
, int64_t offset
,
976 return glfs_zerofill(fd
, offset
, size
);
980 static inline bool gluster_supports_zerofill(void)
985 static inline int qemu_gluster_zerofill(struct glfs_fd
*fd
, int64_t offset
,
992 static int qemu_gluster_create(const char *filename
,
993 QemuOpts
*opts
, Error
**errp
)
995 BlockdevOptionsGluster
*gconf
;
1000 int64_t total_size
= 0;
1003 gconf
= g_new0(BlockdevOptionsGluster
, 1);
1004 gconf
->debug
= qemu_opt_get_number_del(opts
, GLUSTER_OPT_DEBUG
,
1005 GLUSTER_DEBUG_DEFAULT
);
1006 if (gconf
->debug
< 0) {
1008 } else if (gconf
->debug
> GLUSTER_DEBUG_MAX
) {
1009 gconf
->debug
= GLUSTER_DEBUG_MAX
;
1011 gconf
->has_debug
= true;
1013 gconf
->logfile
= qemu_opt_get_del(opts
, GLUSTER_OPT_LOGFILE
);
1014 if (!gconf
->logfile
) {
1015 gconf
->logfile
= g_strdup(GLUSTER_LOGFILE_DEFAULT
);
1017 gconf
->has_logfile
= true;
1019 glfs
= qemu_gluster_init(gconf
, filename
, NULL
, errp
);
1025 total_size
= ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
1028 tmp
= qemu_opt_get_del(opts
, BLOCK_OPT_PREALLOC
);
1029 if (!tmp
|| !strcmp(tmp
, "off")) {
1031 } else if (!strcmp(tmp
, "full") && gluster_supports_zerofill()) {
1034 error_setg(errp
, "Invalid preallocation mode: '%s'"
1035 " or GlusterFS doesn't support zerofill API", tmp
);
1040 fd
= glfs_creat(glfs
, gconf
->path
,
1041 O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
, S_IRUSR
| S_IWUSR
);
1045 if (!glfs_ftruncate(fd
, total_size
)) {
1046 if (prealloc
&& qemu_gluster_zerofill(fd
, 0, total_size
)) {
1053 if (glfs_close(fd
) != 0) {
1059 qapi_free_BlockdevOptionsGluster(gconf
);
1060 glfs_clear_preopened(glfs
);
1064 static coroutine_fn
int qemu_gluster_co_rw(BlockDriverState
*bs
,
1065 int64_t sector_num
, int nb_sectors
,
1066 QEMUIOVector
*qiov
, int write
)
1070 BDRVGlusterState
*s
= bs
->opaque
;
1071 size_t size
= nb_sectors
* BDRV_SECTOR_SIZE
;
1072 off_t offset
= sector_num
* BDRV_SECTOR_SIZE
;
1076 acb
.coroutine
= qemu_coroutine_self();
1077 acb
.aio_context
= bdrv_get_aio_context(bs
);
1080 ret
= glfs_pwritev_async(s
->fd
, qiov
->iov
, qiov
->niov
, offset
, 0,
1081 gluster_finish_aiocb
, &acb
);
1083 ret
= glfs_preadv_async(s
->fd
, qiov
->iov
, qiov
->niov
, offset
, 0,
1084 gluster_finish_aiocb
, &acb
);
1091 qemu_coroutine_yield();
1095 static int qemu_gluster_truncate(BlockDriverState
*bs
, int64_t offset
)
1098 BDRVGlusterState
*s
= bs
->opaque
;
1100 ret
= glfs_ftruncate(s
->fd
, offset
);
1108 static coroutine_fn
int qemu_gluster_co_readv(BlockDriverState
*bs
,
1113 return qemu_gluster_co_rw(bs
, sector_num
, nb_sectors
, qiov
, 0);
1116 static coroutine_fn
int qemu_gluster_co_writev(BlockDriverState
*bs
,
1121 return qemu_gluster_co_rw(bs
, sector_num
, nb_sectors
, qiov
, 1);
1124 static void qemu_gluster_close(BlockDriverState
*bs
)
1126 BDRVGlusterState
*s
= bs
->opaque
;
1133 glfs_clear_preopened(s
->glfs
);
1136 static coroutine_fn
int qemu_gluster_co_flush_to_disk(BlockDriverState
*bs
)
1140 BDRVGlusterState
*s
= bs
->opaque
;
1144 acb
.coroutine
= qemu_coroutine_self();
1145 acb
.aio_context
= bdrv_get_aio_context(bs
);
1147 ret
= glfs_fsync_async(s
->fd
, gluster_finish_aiocb
, &acb
);
1153 qemu_coroutine_yield();
1162 /* Some versions of Gluster (3.5.6 -> 3.5.8?) will not retain its cache
1163 * after a fsync failure, so we have no way of allowing the guest to safely
1164 * continue. Gluster versions prior to 3.5.6 don't retain the cache
1165 * either, but will invalidate the fd on error, so this is again our only
1168 * The 'resync-failed-syncs-after-fsync' xlator option for the
1169 * write-behind cache will cause later gluster versions to retain its
1170 * cache after error, so long as the fd remains open. However, we
1171 * currently have no way of knowing if this option is supported.
1173 * TODO: Once gluster provides a way for us to determine if the option
1174 * is supported, bypass the closure and setting drv to NULL. */
1175 qemu_gluster_close(bs
);
1180 #ifdef CONFIG_GLUSTERFS_DISCARD
1181 static coroutine_fn
int qemu_gluster_co_pdiscard(BlockDriverState
*bs
,
1182 int64_t offset
, int size
)
1186 BDRVGlusterState
*s
= bs
->opaque
;
1190 acb
.coroutine
= qemu_coroutine_self();
1191 acb
.aio_context
= bdrv_get_aio_context(bs
);
1193 ret
= glfs_discard_async(s
->fd
, offset
, size
, gluster_finish_aiocb
, &acb
);
1198 qemu_coroutine_yield();
1203 static int64_t qemu_gluster_getlength(BlockDriverState
*bs
)
1205 BDRVGlusterState
*s
= bs
->opaque
;
1208 ret
= glfs_lseek(s
->fd
, 0, SEEK_END
);
1216 static int64_t qemu_gluster_allocated_file_size(BlockDriverState
*bs
)
1218 BDRVGlusterState
*s
= bs
->opaque
;
1222 ret
= glfs_fstat(s
->fd
, &st
);
1226 return st
.st_blocks
* 512;
1230 static int qemu_gluster_has_zero_init(BlockDriverState
*bs
)
1232 /* GlusterFS volume could be backed by a block device */
1237 * Find allocation range in @bs around offset @start.
1238 * May change underlying file descriptor's file offset.
1239 * If @start is not in a hole, store @start in @data, and the
1240 * beginning of the next hole in @hole, and return 0.
1241 * If @start is in a non-trailing hole, store @start in @hole and the
1242 * beginning of the next non-hole in @data, and return 0.
1243 * If @start is in a trailing hole or beyond EOF, return -ENXIO.
1244 * If we can't find out, return a negative errno other than -ENXIO.
1246 * (Shamefully copied from file-posix.c, only miniscule adaptions.)
1248 static int find_allocation(BlockDriverState
*bs
, off_t start
,
1249 off_t
*data
, off_t
*hole
)
1251 BDRVGlusterState
*s
= bs
->opaque
;
1253 if (!s
->supports_seek_data
) {
1257 #if defined SEEK_HOLE && defined SEEK_DATA
1262 * D1. offs == start: start is in data
1263 * D2. offs > start: start is in a hole, next data at offs
1264 * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
1265 * or start is beyond EOF
1266 * If the latter happens, the file has been truncated behind
1267 * our back since we opened it. All bets are off then.
1268 * Treating like a trailing hole is simplest.
1269 * D4. offs < 0, errno != ENXIO: we learned nothing
1271 offs
= glfs_lseek(s
->fd
, start
, SEEK_DATA
);
1273 return -errno
; /* D3 or D4 */
1275 assert(offs
>= start
);
1278 /* D2: in hole, next data at offs */
1284 /* D1: in data, end not yet known */
1288 * H1. offs == start: start is in a hole
1289 * If this happens here, a hole has been dug behind our back
1290 * since the previous lseek().
1291 * H2. offs > start: either start is in data, next hole at offs,
1292 * or start is in trailing hole, EOF at offs
1293 * Linux treats trailing holes like any other hole: offs ==
1294 * start. Solaris seeks to EOF instead: offs > start (blech).
1295 * If that happens here, a hole has been dug behind our back
1296 * since the previous lseek().
1297 * H3. offs < 0, errno = ENXIO: start is beyond EOF
1298 * If this happens, the file has been truncated behind our
1299 * back since we opened it. Treat it like a trailing hole.
1300 * H4. offs < 0, errno != ENXIO: we learned nothing
1301 * Pretend we know nothing at all, i.e. "forget" about D1.
1303 offs
= glfs_lseek(s
->fd
, start
, SEEK_HOLE
);
1305 return -errno
; /* D1 and (H3 or H4) */
1307 assert(offs
>= start
);
1311 * D1 and H2: either in data, next hole at offs, or it was in
1312 * data but is now in a trailing hole. In the latter case,
1313 * all bets are off. Treating it as if it there was data all
1314 * the way to EOF is safe, so simply do that.
1330 * Returns the allocation status of the specified sectors.
1332 * If 'sector_num' is beyond the end of the disk image the return value is 0
1333 * and 'pnum' is set to 0.
1335 * 'pnum' is set to the number of sectors (including and immediately following
1336 * the specified sector) that are known to be in the same
1337 * allocated/unallocated state.
1339 * 'nb_sectors' is the max value 'pnum' should be set to. If nb_sectors goes
1340 * beyond the end of the disk image it will be clamped.
1342 * (Based on raw_co_get_block_status() from file-posix.c.)
1344 static int64_t coroutine_fn
qemu_gluster_co_get_block_status(
1345 BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
, int *pnum
,
1346 BlockDriverState
**file
)
1348 BDRVGlusterState
*s
= bs
->opaque
;
1349 off_t start
, data
= 0, hole
= 0;
1357 start
= sector_num
* BDRV_SECTOR_SIZE
;
1358 total_size
= bdrv_getlength(bs
);
1359 if (total_size
< 0) {
1361 } else if (start
>= total_size
) {
1364 } else if (start
+ nb_sectors
* BDRV_SECTOR_SIZE
> total_size
) {
1365 nb_sectors
= DIV_ROUND_UP(total_size
- start
, BDRV_SECTOR_SIZE
);
1368 ret
= find_allocation(bs
, start
, &data
, &hole
);
1369 if (ret
== -ENXIO
) {
1372 ret
= BDRV_BLOCK_ZERO
;
1373 } else if (ret
< 0) {
1374 /* No info available, so pretend there are no holes */
1376 ret
= BDRV_BLOCK_DATA
;
1377 } else if (data
== start
) {
1378 /* On a data extent, compute sectors to the end of the extent,
1379 * possibly including a partial sector at EOF. */
1380 *pnum
= MIN(nb_sectors
, DIV_ROUND_UP(hole
- start
, BDRV_SECTOR_SIZE
));
1381 ret
= BDRV_BLOCK_DATA
;
1383 /* On a hole, compute sectors to the beginning of the next extent. */
1384 assert(hole
== start
);
1385 *pnum
= MIN(nb_sectors
, (data
- start
) / BDRV_SECTOR_SIZE
);
1386 ret
= BDRV_BLOCK_ZERO
;
1391 return ret
| BDRV_BLOCK_OFFSET_VALID
| start
;
1395 static BlockDriver bdrv_gluster
= {
1396 .format_name
= "gluster",
1397 .protocol_name
= "gluster",
1398 .instance_size
= sizeof(BDRVGlusterState
),
1399 .bdrv_needs_filename
= false,
1400 .bdrv_file_open
= qemu_gluster_open
,
1401 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1402 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1403 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1404 .bdrv_close
= qemu_gluster_close
,
1405 .bdrv_create
= qemu_gluster_create
,
1406 .bdrv_getlength
= qemu_gluster_getlength
,
1407 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1408 .bdrv_truncate
= qemu_gluster_truncate
,
1409 .bdrv_co_readv
= qemu_gluster_co_readv
,
1410 .bdrv_co_writev
= qemu_gluster_co_writev
,
1411 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1412 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1413 #ifdef CONFIG_GLUSTERFS_DISCARD
1414 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1416 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1417 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1419 .bdrv_co_get_block_status
= qemu_gluster_co_get_block_status
,
1420 .create_opts
= &qemu_gluster_create_opts
,
1423 static BlockDriver bdrv_gluster_tcp
= {
1424 .format_name
= "gluster",
1425 .protocol_name
= "gluster+tcp",
1426 .instance_size
= sizeof(BDRVGlusterState
),
1427 .bdrv_needs_filename
= false,
1428 .bdrv_file_open
= qemu_gluster_open
,
1429 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1430 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1431 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1432 .bdrv_close
= qemu_gluster_close
,
1433 .bdrv_create
= qemu_gluster_create
,
1434 .bdrv_getlength
= qemu_gluster_getlength
,
1435 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1436 .bdrv_truncate
= qemu_gluster_truncate
,
1437 .bdrv_co_readv
= qemu_gluster_co_readv
,
1438 .bdrv_co_writev
= qemu_gluster_co_writev
,
1439 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1440 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1441 #ifdef CONFIG_GLUSTERFS_DISCARD
1442 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1444 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1445 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1447 .bdrv_co_get_block_status
= qemu_gluster_co_get_block_status
,
1448 .create_opts
= &qemu_gluster_create_opts
,
1451 static BlockDriver bdrv_gluster_unix
= {
1452 .format_name
= "gluster",
1453 .protocol_name
= "gluster+unix",
1454 .instance_size
= sizeof(BDRVGlusterState
),
1455 .bdrv_needs_filename
= true,
1456 .bdrv_file_open
= qemu_gluster_open
,
1457 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1458 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1459 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1460 .bdrv_close
= qemu_gluster_close
,
1461 .bdrv_create
= qemu_gluster_create
,
1462 .bdrv_getlength
= qemu_gluster_getlength
,
1463 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1464 .bdrv_truncate
= qemu_gluster_truncate
,
1465 .bdrv_co_readv
= qemu_gluster_co_readv
,
1466 .bdrv_co_writev
= qemu_gluster_co_writev
,
1467 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1468 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1469 #ifdef CONFIG_GLUSTERFS_DISCARD
1470 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1472 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1473 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1475 .bdrv_co_get_block_status
= qemu_gluster_co_get_block_status
,
1476 .create_opts
= &qemu_gluster_create_opts
,
1479 /* rdma is deprecated (actually never supported for volfile fetch).
1480 * Let's maintain it for the protocol compatibility, to make sure things
1481 * won't break immediately. For now, gluster+rdma will fall back to gluster+tcp
1482 * protocol with a warning.
1483 * TODO: remove gluster+rdma interface support
1485 static BlockDriver bdrv_gluster_rdma
= {
1486 .format_name
= "gluster",
1487 .protocol_name
= "gluster+rdma",
1488 .instance_size
= sizeof(BDRVGlusterState
),
1489 .bdrv_needs_filename
= true,
1490 .bdrv_file_open
= qemu_gluster_open
,
1491 .bdrv_reopen_prepare
= qemu_gluster_reopen_prepare
,
1492 .bdrv_reopen_commit
= qemu_gluster_reopen_commit
,
1493 .bdrv_reopen_abort
= qemu_gluster_reopen_abort
,
1494 .bdrv_close
= qemu_gluster_close
,
1495 .bdrv_create
= qemu_gluster_create
,
1496 .bdrv_getlength
= qemu_gluster_getlength
,
1497 .bdrv_get_allocated_file_size
= qemu_gluster_allocated_file_size
,
1498 .bdrv_truncate
= qemu_gluster_truncate
,
1499 .bdrv_co_readv
= qemu_gluster_co_readv
,
1500 .bdrv_co_writev
= qemu_gluster_co_writev
,
1501 .bdrv_co_flush_to_disk
= qemu_gluster_co_flush_to_disk
,
1502 .bdrv_has_zero_init
= qemu_gluster_has_zero_init
,
1503 #ifdef CONFIG_GLUSTERFS_DISCARD
1504 .bdrv_co_pdiscard
= qemu_gluster_co_pdiscard
,
1506 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1507 .bdrv_co_pwrite_zeroes
= qemu_gluster_co_pwrite_zeroes
,
1509 .bdrv_co_get_block_status
= qemu_gluster_co_get_block_status
,
1510 .create_opts
= &qemu_gluster_create_opts
,
1513 static void bdrv_gluster_init(void)
1515 bdrv_register(&bdrv_gluster_rdma
);
1516 bdrv_register(&bdrv_gluster_unix
);
1517 bdrv_register(&bdrv_gluster_tcp
);
1518 bdrv_register(&bdrv_gluster
);
1521 block_init(bdrv_gluster_init
);