xref: /openbmc/qemu/block/gluster.c (revision dec490db)
1 /*
2  * GlusterFS backend for QEMU
3  *
4  * Copyright (C) 2012 Bharata B Rao <bharata@linux.vnet.ibm.com>
5  *
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.
8  *
9  */
10 
11 #include "qemu/osdep.h"
12 #include "qemu/units.h"
13 #include <glusterfs/api/glfs.h>
14 #include "block/block_int.h"
15 #include "block/qdict.h"
16 #include "qapi/error.h"
17 #include "qapi/qmp/qdict.h"
18 #include "qapi/qmp/qerror.h"
19 #include "qemu/uri.h"
20 #include "qemu/error-report.h"
21 #include "qemu/module.h"
22 #include "qemu/option.h"
23 #include "qemu/cutils.h"
24 
25 #ifdef CONFIG_GLUSTERFS_FTRUNCATE_HAS_STAT
26 # define glfs_ftruncate(fd, offset) glfs_ftruncate(fd, offset, NULL, NULL)
27 #endif
28 
29 #define GLUSTER_OPT_FILENAME        "filename"
30 #define GLUSTER_OPT_VOLUME          "volume"
31 #define GLUSTER_OPT_PATH            "path"
32 #define GLUSTER_OPT_TYPE            "type"
33 #define GLUSTER_OPT_SERVER_PATTERN  "server."
34 #define GLUSTER_OPT_HOST            "host"
35 #define GLUSTER_OPT_PORT            "port"
36 #define GLUSTER_OPT_TO              "to"
37 #define GLUSTER_OPT_IPV4            "ipv4"
38 #define GLUSTER_OPT_IPV6            "ipv6"
39 #define GLUSTER_OPT_SOCKET          "socket"
40 #define GLUSTER_OPT_DEBUG           "debug"
41 #define GLUSTER_DEFAULT_PORT        24007
42 #define GLUSTER_DEBUG_DEFAULT       4
43 #define GLUSTER_DEBUG_MAX           9
44 #define GLUSTER_OPT_LOGFILE         "logfile"
45 #define GLUSTER_LOGFILE_DEFAULT     "-" /* handled in libgfapi as /dev/stderr */
46 /*
47  * Several versions of GlusterFS (3.12? -> 6.0.1) fail when the transfer size
48  * is greater or equal to 1024 MiB, so we are limiting the transfer size to 512
49  * MiB to avoid this rare issue.
50  */
51 #define GLUSTER_MAX_TRANSFER        (512 * MiB)
52 
53 #define GERR_INDEX_HINT "hint: check in 'server' array index '%d'\n"
54 
55 typedef struct GlusterAIOCB {
56     int64_t size;
57     int ret;
58     Coroutine *coroutine;
59     AioContext *aio_context;
60 } GlusterAIOCB;
61 
62 typedef struct BDRVGlusterState {
63     struct glfs *glfs;
64     struct glfs_fd *fd;
65     char *logfile;
66     bool supports_seek_data;
67     int debug;
68 } BDRVGlusterState;
69 
70 typedef struct BDRVGlusterReopenState {
71     struct glfs *glfs;
72     struct glfs_fd *fd;
73 } BDRVGlusterReopenState;
74 
75 
76 typedef struct GlfsPreopened {
77     char *volume;
78     glfs_t *fs;
79     int ref;
80 } GlfsPreopened;
81 
82 typedef struct ListElement {
83     QLIST_ENTRY(ListElement) list;
84     GlfsPreopened saved;
85 } ListElement;
86 
87 static QLIST_HEAD(, ListElement) glfs_list;
88 
89 static QemuOptsList qemu_gluster_create_opts = {
90     .name = "qemu-gluster-create-opts",
91     .head = QTAILQ_HEAD_INITIALIZER(qemu_gluster_create_opts.head),
92     .desc = {
93         {
94             .name = BLOCK_OPT_SIZE,
95             .type = QEMU_OPT_SIZE,
96             .help = "Virtual disk size"
97         },
98         {
99             .name = BLOCK_OPT_PREALLOC,
100             .type = QEMU_OPT_STRING,
101             .help = "Preallocation mode (allowed values: off"
102 #ifdef CONFIG_GLUSTERFS_FALLOCATE
103                     ", falloc"
104 #endif
105 #ifdef CONFIG_GLUSTERFS_ZEROFILL
106                     ", full"
107 #endif
108                     ")"
109         },
110         {
111             .name = GLUSTER_OPT_DEBUG,
112             .type = QEMU_OPT_NUMBER,
113             .help = "Gluster log level, valid range is 0-9",
114         },
115         {
116             .name = GLUSTER_OPT_LOGFILE,
117             .type = QEMU_OPT_STRING,
118             .help = "Logfile path of libgfapi",
119         },
120         { /* end of list */ }
121     }
122 };
123 
124 static QemuOptsList runtime_opts = {
125     .name = "gluster",
126     .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
127     .desc = {
128         {
129             .name = GLUSTER_OPT_FILENAME,
130             .type = QEMU_OPT_STRING,
131             .help = "URL to the gluster image",
132         },
133         {
134             .name = GLUSTER_OPT_DEBUG,
135             .type = QEMU_OPT_NUMBER,
136             .help = "Gluster log level, valid range is 0-9",
137         },
138         {
139             .name = GLUSTER_OPT_LOGFILE,
140             .type = QEMU_OPT_STRING,
141             .help = "Logfile path of libgfapi",
142         },
143         { /* end of list */ }
144     },
145 };
146 
147 static QemuOptsList runtime_json_opts = {
148     .name = "gluster_json",
149     .head = QTAILQ_HEAD_INITIALIZER(runtime_json_opts.head),
150     .desc = {
151         {
152             .name = GLUSTER_OPT_VOLUME,
153             .type = QEMU_OPT_STRING,
154             .help = "name of gluster volume where VM image resides",
155         },
156         {
157             .name = GLUSTER_OPT_PATH,
158             .type = QEMU_OPT_STRING,
159             .help = "absolute path to image file in gluster volume",
160         },
161         {
162             .name = GLUSTER_OPT_DEBUG,
163             .type = QEMU_OPT_NUMBER,
164             .help = "Gluster log level, valid range is 0-9",
165         },
166         { /* end of list */ }
167     },
168 };
169 
170 static QemuOptsList runtime_type_opts = {
171     .name = "gluster_type",
172     .head = QTAILQ_HEAD_INITIALIZER(runtime_type_opts.head),
173     .desc = {
174         {
175             .name = GLUSTER_OPT_TYPE,
176             .type = QEMU_OPT_STRING,
177             .help = "inet|unix",
178         },
179         { /* end of list */ }
180     },
181 };
182 
183 static QemuOptsList runtime_unix_opts = {
184     .name = "gluster_unix",
185     .head = QTAILQ_HEAD_INITIALIZER(runtime_unix_opts.head),
186     .desc = {
187         {
188             .name = GLUSTER_OPT_SOCKET,
189             .type = QEMU_OPT_STRING,
190             .help = "socket file path (legacy)",
191         },
192         {
193             .name = GLUSTER_OPT_PATH,
194             .type = QEMU_OPT_STRING,
195             .help = "socket file path (QAPI)",
196         },
197         { /* end of list */ }
198     },
199 };
200 
201 static QemuOptsList runtime_inet_opts = {
202     .name = "gluster_inet",
203     .head = QTAILQ_HEAD_INITIALIZER(runtime_inet_opts.head),
204     .desc = {
205         {
206             .name = GLUSTER_OPT_TYPE,
207             .type = QEMU_OPT_STRING,
208             .help = "inet|unix",
209         },
210         {
211             .name = GLUSTER_OPT_HOST,
212             .type = QEMU_OPT_STRING,
213             .help = "host address (hostname/ipv4/ipv6 addresses)",
214         },
215         {
216             .name = GLUSTER_OPT_PORT,
217             .type = QEMU_OPT_STRING,
218             .help = "port number on which glusterd is listening (default 24007)",
219         },
220         {
221             .name = "to",
222             .type = QEMU_OPT_NUMBER,
223             .help = "max port number, not supported by gluster",
224         },
225         {
226             .name = "ipv4",
227             .type = QEMU_OPT_BOOL,
228             .help = "ipv4 bool value, not supported by gluster",
229         },
230         {
231             .name = "ipv6",
232             .type = QEMU_OPT_BOOL,
233             .help = "ipv6 bool value, not supported by gluster",
234         },
235         { /* end of list */ }
236     },
237 };
238 
239 static void glfs_set_preopened(const char *volume, glfs_t *fs)
240 {
241     ListElement *entry = NULL;
242 
243     entry = g_new(ListElement, 1);
244 
245     entry->saved.volume = g_strdup(volume);
246 
247     entry->saved.fs = fs;
248     entry->saved.ref = 1;
249 
250     QLIST_INSERT_HEAD(&glfs_list, entry, list);
251 }
252 
253 static glfs_t *glfs_find_preopened(const char *volume)
254 {
255     ListElement *entry = NULL;
256 
257      QLIST_FOREACH(entry, &glfs_list, list) {
258         if (strcmp(entry->saved.volume, volume) == 0) {
259             entry->saved.ref++;
260             return entry->saved.fs;
261         }
262      }
263 
264     return NULL;
265 }
266 
267 static void glfs_clear_preopened(glfs_t *fs)
268 {
269     ListElement *entry = NULL;
270     ListElement *next;
271 
272     if (fs == NULL) {
273         return;
274     }
275 
276     QLIST_FOREACH_SAFE(entry, &glfs_list, list, next) {
277         if (entry->saved.fs == fs) {
278             if (--entry->saved.ref) {
279                 return;
280             }
281 
282             QLIST_REMOVE(entry, list);
283 
284             glfs_fini(entry->saved.fs);
285             g_free(entry->saved.volume);
286             g_free(entry);
287         }
288     }
289 }
290 
291 static int parse_volume_options(BlockdevOptionsGluster *gconf, char *path)
292 {
293     char *p, *q;
294 
295     if (!path) {
296         return -EINVAL;
297     }
298 
299     /* volume */
300     p = q = path + strspn(path, "/");
301     p += strcspn(p, "/");
302     if (*p == '\0') {
303         return -EINVAL;
304     }
305     gconf->volume = g_strndup(q, p - q);
306 
307     /* path */
308     p += strspn(p, "/");
309     if (*p == '\0') {
310         return -EINVAL;
311     }
312     gconf->path = g_strdup(p);
313     return 0;
314 }
315 
316 /*
317  * file=gluster[+transport]://[host[:port]]/volume/path[?socket=...]
318  *
319  * 'gluster' is the protocol.
320  *
321  * 'transport' specifies the transport type used to connect to gluster
322  * management daemon (glusterd). Valid transport types are
323  * tcp or unix. If a transport type isn't specified, then tcp type is assumed.
324  *
325  * 'host' specifies the host where the volume file specification for
326  * the given volume resides. This can be either hostname or ipv4 address.
327  * If transport type is 'unix', then 'host' field should not be specified.
328  * The 'socket' field needs to be populated with the path to unix domain
329  * socket.
330  *
331  * 'port' is the port number on which glusterd is listening. This is optional
332  * and if not specified, QEMU will send 0 which will make gluster to use the
333  * default port. If the transport type is unix, then 'port' should not be
334  * specified.
335  *
336  * 'volume' is the name of the gluster volume which contains the VM image.
337  *
338  * 'path' is the path to the actual VM image that resides on gluster volume.
339  *
340  * Examples:
341  *
342  * file=gluster://1.2.3.4/testvol/a.img
343  * file=gluster+tcp://1.2.3.4/testvol/a.img
344  * file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
345  * file=gluster+tcp://host.domain.com:24007/testvol/dir/a.img
346  * file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
347  */
348 static int qemu_gluster_parse_uri(BlockdevOptionsGluster *gconf,
349                                   const char *filename)
350 {
351     SocketAddress *gsconf;
352     URI *uri;
353     QueryParams *qp = NULL;
354     bool is_unix = false;
355     int ret = 0;
356 
357     uri = uri_parse(filename);
358     if (!uri) {
359         return -EINVAL;
360     }
361 
362     gsconf = g_new0(SocketAddress, 1);
363     QAPI_LIST_PREPEND(gconf->server, gsconf);
364 
365     /* transport */
366     if (!uri->scheme || !strcmp(uri->scheme, "gluster")) {
367         gsconf->type = SOCKET_ADDRESS_TYPE_INET;
368     } else if (!strcmp(uri->scheme, "gluster+tcp")) {
369         gsconf->type = SOCKET_ADDRESS_TYPE_INET;
370     } else if (!strcmp(uri->scheme, "gluster+unix")) {
371         gsconf->type = SOCKET_ADDRESS_TYPE_UNIX;
372         is_unix = true;
373     } else if (!strcmp(uri->scheme, "gluster+rdma")) {
374         gsconf->type = SOCKET_ADDRESS_TYPE_INET;
375         warn_report("rdma feature is not supported, falling back to tcp");
376     } else {
377         ret = -EINVAL;
378         goto out;
379     }
380 
381     ret = parse_volume_options(gconf, uri->path);
382     if (ret < 0) {
383         goto out;
384     }
385 
386     qp = query_params_parse(uri->query);
387     if (qp->n > 1 || (is_unix && !qp->n) || (!is_unix && qp->n)) {
388         ret = -EINVAL;
389         goto out;
390     }
391 
392     if (is_unix) {
393         if (uri->server || uri->port) {
394             ret = -EINVAL;
395             goto out;
396         }
397         if (strcmp(qp->p[0].name, "socket")) {
398             ret = -EINVAL;
399             goto out;
400         }
401         gsconf->u.q_unix.path = g_strdup(qp->p[0].value);
402     } else {
403         gsconf->u.inet.host = g_strdup(uri->server ? uri->server : "localhost");
404         if (uri->port) {
405             gsconf->u.inet.port = g_strdup_printf("%d", uri->port);
406         } else {
407             gsconf->u.inet.port = g_strdup_printf("%d", GLUSTER_DEFAULT_PORT);
408         }
409     }
410 
411 out:
412     if (qp) {
413         query_params_free(qp);
414     }
415     uri_free(uri);
416     return ret;
417 }
418 
419 static struct glfs *qemu_gluster_glfs_init(BlockdevOptionsGluster *gconf,
420                                            Error **errp)
421 {
422     struct glfs *glfs;
423     int ret;
424     int old_errno;
425     SocketAddressList *server;
426     unsigned long long port;
427 
428     glfs = glfs_find_preopened(gconf->volume);
429     if (glfs) {
430         return glfs;
431     }
432 
433     glfs = glfs_new(gconf->volume);
434     if (!glfs) {
435         goto out;
436     }
437 
438     glfs_set_preopened(gconf->volume, glfs);
439 
440     for (server = gconf->server; server; server = server->next) {
441         switch (server->value->type) {
442         case SOCKET_ADDRESS_TYPE_UNIX:
443             ret = glfs_set_volfile_server(glfs, "unix",
444                                    server->value->u.q_unix.path, 0);
445             break;
446         case SOCKET_ADDRESS_TYPE_INET:
447             if (parse_uint_full(server->value->u.inet.port, &port, 10) < 0 ||
448                 port > 65535) {
449                 error_setg(errp, "'%s' is not a valid port number",
450                            server->value->u.inet.port);
451                 errno = EINVAL;
452                 goto out;
453             }
454             ret = glfs_set_volfile_server(glfs, "tcp",
455                                    server->value->u.inet.host,
456                                    (int)port);
457             break;
458         case SOCKET_ADDRESS_TYPE_VSOCK:
459         case SOCKET_ADDRESS_TYPE_FD:
460         default:
461             abort();
462         }
463 
464         if (ret < 0) {
465             goto out;
466         }
467     }
468 
469     ret = glfs_set_logging(glfs, gconf->logfile, gconf->debug);
470     if (ret < 0) {
471         goto out;
472     }
473 
474     ret = glfs_init(glfs);
475     if (ret) {
476         error_setg(errp, "Gluster connection for volume %s, path %s failed"
477                          " to connect", gconf->volume, gconf->path);
478         for (server = gconf->server; server; server = server->next) {
479             if (server->value->type  == SOCKET_ADDRESS_TYPE_UNIX) {
480                 error_append_hint(errp, "hint: failed on socket %s ",
481                                   server->value->u.q_unix.path);
482             } else {
483                 error_append_hint(errp, "hint: failed on host %s and port %s ",
484                                   server->value->u.inet.host,
485                                   server->value->u.inet.port);
486             }
487         }
488 
489         error_append_hint(errp, "Please refer to gluster logs for more info\n");
490 
491         /* glfs_init sometimes doesn't set errno although docs suggest that */
492         if (errno == 0) {
493             errno = EINVAL;
494         }
495 
496         goto out;
497     }
498     return glfs;
499 
500 out:
501     if (glfs) {
502         old_errno = errno;
503         glfs_clear_preopened(glfs);
504         errno = old_errno;
505     }
506     return NULL;
507 }
508 
509 /*
510  * Convert the json formatted command line into qapi.
511 */
512 static int qemu_gluster_parse_json(BlockdevOptionsGluster *gconf,
513                                   QDict *options, Error **errp)
514 {
515     QemuOpts *opts;
516     SocketAddress *gsconf = NULL;
517     SocketAddressList **tail;
518     QDict *backing_options = NULL;
519     Error *local_err = NULL;
520     char *str = NULL;
521     const char *ptr;
522     int i, type, num_servers;
523 
524     /* create opts info from runtime_json_opts list */
525     opts = qemu_opts_create(&runtime_json_opts, NULL, 0, &error_abort);
526     if (!qemu_opts_absorb_qdict(opts, options, errp)) {
527         goto out;
528     }
529 
530     num_servers = qdict_array_entries(options, GLUSTER_OPT_SERVER_PATTERN);
531     if (num_servers < 1) {
532         error_setg(&local_err, QERR_MISSING_PARAMETER, "server");
533         goto out;
534     }
535 
536     ptr = qemu_opt_get(opts, GLUSTER_OPT_VOLUME);
537     if (!ptr) {
538         error_setg(&local_err, QERR_MISSING_PARAMETER, GLUSTER_OPT_VOLUME);
539         goto out;
540     }
541     gconf->volume = g_strdup(ptr);
542 
543     ptr = qemu_opt_get(opts, GLUSTER_OPT_PATH);
544     if (!ptr) {
545         error_setg(&local_err, QERR_MISSING_PARAMETER, GLUSTER_OPT_PATH);
546         goto out;
547     }
548     gconf->path = g_strdup(ptr);
549     qemu_opts_del(opts);
550     tail = &gconf->server;
551 
552     for (i = 0; i < num_servers; i++) {
553         str = g_strdup_printf(GLUSTER_OPT_SERVER_PATTERN"%d.", i);
554         qdict_extract_subqdict(options, &backing_options, str);
555 
556         /* create opts info from runtime_type_opts list */
557         opts = qemu_opts_create(&runtime_type_opts, NULL, 0, &error_abort);
558         if (!qemu_opts_absorb_qdict(opts, backing_options, errp)) {
559             goto out;
560         }
561 
562         ptr = qemu_opt_get(opts, GLUSTER_OPT_TYPE);
563         if (!ptr) {
564             error_setg(&local_err, QERR_MISSING_PARAMETER, GLUSTER_OPT_TYPE);
565             error_append_hint(&local_err, GERR_INDEX_HINT, i);
566             goto out;
567 
568         }
569         gsconf = g_new0(SocketAddress, 1);
570         if (!strcmp(ptr, "tcp")) {
571             ptr = "inet";       /* accept legacy "tcp" */
572         }
573         type = qapi_enum_parse(&SocketAddressType_lookup, ptr, -1, NULL);
574         if (type != SOCKET_ADDRESS_TYPE_INET
575             && type != SOCKET_ADDRESS_TYPE_UNIX) {
576             error_setg(&local_err,
577                        "Parameter '%s' may be 'inet' or 'unix'",
578                        GLUSTER_OPT_TYPE);
579             error_append_hint(&local_err, GERR_INDEX_HINT, i);
580             goto out;
581         }
582         gsconf->type = type;
583         qemu_opts_del(opts);
584 
585         if (gsconf->type == SOCKET_ADDRESS_TYPE_INET) {
586             /* create opts info from runtime_inet_opts list */
587             opts = qemu_opts_create(&runtime_inet_opts, NULL, 0, &error_abort);
588             if (!qemu_opts_absorb_qdict(opts, backing_options, errp)) {
589                 goto out;
590             }
591 
592             ptr = qemu_opt_get(opts, GLUSTER_OPT_HOST);
593             if (!ptr) {
594                 error_setg(&local_err, QERR_MISSING_PARAMETER,
595                            GLUSTER_OPT_HOST);
596                 error_append_hint(&local_err, GERR_INDEX_HINT, i);
597                 goto out;
598             }
599             gsconf->u.inet.host = g_strdup(ptr);
600             ptr = qemu_opt_get(opts, GLUSTER_OPT_PORT);
601             if (!ptr) {
602                 error_setg(&local_err, QERR_MISSING_PARAMETER,
603                            GLUSTER_OPT_PORT);
604                 error_append_hint(&local_err, GERR_INDEX_HINT, i);
605                 goto out;
606             }
607             gsconf->u.inet.port = g_strdup(ptr);
608 
609             /* defend for unsupported fields in InetSocketAddress,
610              * i.e. @ipv4, @ipv6  and @to
611              */
612             ptr = qemu_opt_get(opts, GLUSTER_OPT_TO);
613             if (ptr) {
614                 gsconf->u.inet.has_to = true;
615             }
616             ptr = qemu_opt_get(opts, GLUSTER_OPT_IPV4);
617             if (ptr) {
618                 gsconf->u.inet.has_ipv4 = true;
619             }
620             ptr = qemu_opt_get(opts, GLUSTER_OPT_IPV6);
621             if (ptr) {
622                 gsconf->u.inet.has_ipv6 = true;
623             }
624             if (gsconf->u.inet.has_to) {
625                 error_setg(&local_err, "Parameter 'to' not supported");
626                 goto out;
627             }
628             if (gsconf->u.inet.has_ipv4 || gsconf->u.inet.has_ipv6) {
629                 error_setg(&local_err, "Parameters 'ipv4/ipv6' not supported");
630                 goto out;
631             }
632             qemu_opts_del(opts);
633         } else {
634             /* create opts info from runtime_unix_opts list */
635             opts = qemu_opts_create(&runtime_unix_opts, NULL, 0, &error_abort);
636             if (!qemu_opts_absorb_qdict(opts, backing_options, errp)) {
637                 goto out;
638             }
639 
640             ptr = qemu_opt_get(opts, GLUSTER_OPT_PATH);
641             if (!ptr) {
642                 ptr = qemu_opt_get(opts, GLUSTER_OPT_SOCKET);
643             } else if (qemu_opt_get(opts, GLUSTER_OPT_SOCKET)) {
644                 error_setg(&local_err,
645                            "Conflicting parameters 'path' and 'socket'");
646                 error_append_hint(&local_err, GERR_INDEX_HINT, i);
647                 goto out;
648             }
649             if (!ptr) {
650                 error_setg(&local_err, QERR_MISSING_PARAMETER,
651                            GLUSTER_OPT_PATH);
652                 error_append_hint(&local_err, GERR_INDEX_HINT, i);
653                 goto out;
654             }
655             gsconf->u.q_unix.path = g_strdup(ptr);
656             qemu_opts_del(opts);
657         }
658 
659         QAPI_LIST_APPEND(tail, gsconf);
660         gsconf = NULL;
661 
662         qobject_unref(backing_options);
663         backing_options = NULL;
664         g_free(str);
665         str = NULL;
666     }
667 
668     return 0;
669 
670 out:
671     error_propagate(errp, local_err);
672     qapi_free_SocketAddress(gsconf);
673     qemu_opts_del(opts);
674     g_free(str);
675     qobject_unref(backing_options);
676     errno = EINVAL;
677     return -errno;
678 }
679 
680 /* Converts options given in @filename and the @options QDict into the QAPI
681  * object @gconf. */
682 static int qemu_gluster_parse(BlockdevOptionsGluster *gconf,
683                               const char *filename,
684                               QDict *options, Error **errp)
685 {
686     int ret;
687     if (filename) {
688         ret = qemu_gluster_parse_uri(gconf, filename);
689         if (ret < 0) {
690             error_setg(errp, "invalid URI %s", filename);
691             error_append_hint(errp, "Usage: file=gluster[+transport]://"
692                                     "[host[:port]]volume/path[?socket=...]"
693                                     "[,file.debug=N]"
694                                     "[,file.logfile=/path/filename.log]\n");
695             return ret;
696         }
697     } else {
698         ret = qemu_gluster_parse_json(gconf, options, errp);
699         if (ret < 0) {
700             error_append_hint(errp, "Usage: "
701                              "-drive driver=qcow2,file.driver=gluster,"
702                              "file.volume=testvol,file.path=/path/a.qcow2"
703                              "[,file.debug=9]"
704                              "[,file.logfile=/path/filename.log],"
705                              "file.server.0.type=inet,"
706                              "file.server.0.host=1.2.3.4,"
707                              "file.server.0.port=24007,"
708                              "file.server.1.transport=unix,"
709                              "file.server.1.path=/var/run/glusterd.socket ..."
710                              "\n");
711             return ret;
712         }
713     }
714 
715     return 0;
716 }
717 
718 static struct glfs *qemu_gluster_init(BlockdevOptionsGluster *gconf,
719                                       const char *filename,
720                                       QDict *options, Error **errp)
721 {
722     int ret;
723 
724     ret = qemu_gluster_parse(gconf, filename, options, errp);
725     if (ret < 0) {
726         errno = -ret;
727         return NULL;
728     }
729 
730     return qemu_gluster_glfs_init(gconf, errp);
731 }
732 
733 /*
734  * AIO callback routine called from GlusterFS thread.
735  */
736 static void gluster_finish_aiocb(struct glfs_fd *fd, ssize_t ret,
737 #ifdef CONFIG_GLUSTERFS_IOCB_HAS_STAT
738                                  struct glfs_stat *pre, struct glfs_stat *post,
739 #endif
740                                  void *arg)
741 {
742     GlusterAIOCB *acb = (GlusterAIOCB *)arg;
743 
744     if (!ret || ret == acb->size) {
745         acb->ret = 0; /* Success */
746     } else if (ret < 0) {
747         acb->ret = -errno; /* Read/Write failed */
748     } else {
749         acb->ret = -EIO; /* Partial read/write - fail it */
750     }
751 
752     aio_co_schedule(acb->aio_context, acb->coroutine);
753 }
754 
755 static void qemu_gluster_parse_flags(int bdrv_flags, int *open_flags)
756 {
757     assert(open_flags != NULL);
758 
759     *open_flags |= O_BINARY;
760 
761     if (bdrv_flags & BDRV_O_RDWR) {
762         *open_flags |= O_RDWR;
763     } else {
764         *open_flags |= O_RDONLY;
765     }
766 
767     if ((bdrv_flags & BDRV_O_NOCACHE)) {
768         *open_flags |= O_DIRECT;
769     }
770 }
771 
772 /*
773  * Do SEEK_DATA/HOLE to detect if it is functional. Older broken versions of
774  * gfapi incorrectly return the current offset when SEEK_DATA/HOLE is used.
775  * - Corrected versions return -1 and set errno to EINVAL.
776  * - Versions that support SEEK_DATA/HOLE correctly, will return -1 and set
777  *   errno to ENXIO when SEEK_DATA is called with a position of EOF.
778  */
779 static bool qemu_gluster_test_seek(struct glfs_fd *fd)
780 {
781     off_t ret = 0;
782 
783 #if defined SEEK_HOLE && defined SEEK_DATA
784     off_t eof;
785 
786     eof = glfs_lseek(fd, 0, SEEK_END);
787     if (eof < 0) {
788         /* this should never occur */
789         return false;
790     }
791 
792     /* this should always fail with ENXIO if SEEK_DATA is supported */
793     ret = glfs_lseek(fd, eof, SEEK_DATA);
794 #endif
795 
796     return (ret < 0) && (errno == ENXIO);
797 }
798 
799 static int qemu_gluster_open(BlockDriverState *bs,  QDict *options,
800                              int bdrv_flags, Error **errp)
801 {
802     BDRVGlusterState *s = bs->opaque;
803     int open_flags = 0;
804     int ret = 0;
805     BlockdevOptionsGluster *gconf = NULL;
806     QemuOpts *opts;
807     const char *filename, *logfile;
808 
809     opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
810     if (!qemu_opts_absorb_qdict(opts, options, errp)) {
811         ret = -EINVAL;
812         goto out;
813     }
814 
815     filename = qemu_opt_get(opts, GLUSTER_OPT_FILENAME);
816 
817     s->debug = qemu_opt_get_number(opts, GLUSTER_OPT_DEBUG,
818                                    GLUSTER_DEBUG_DEFAULT);
819     if (s->debug < 0) {
820         s->debug = 0;
821     } else if (s->debug > GLUSTER_DEBUG_MAX) {
822         s->debug = GLUSTER_DEBUG_MAX;
823     }
824 
825     gconf = g_new0(BlockdevOptionsGluster, 1);
826     gconf->debug = s->debug;
827     gconf->has_debug = true;
828 
829     logfile = qemu_opt_get(opts, GLUSTER_OPT_LOGFILE);
830     s->logfile = g_strdup(logfile ? logfile : GLUSTER_LOGFILE_DEFAULT);
831 
832     gconf->logfile = g_strdup(s->logfile);
833     gconf->has_logfile = true;
834 
835     s->glfs = qemu_gluster_init(gconf, filename, options, errp);
836     if (!s->glfs) {
837         ret = -errno;
838         goto out;
839     }
840 
841 #ifdef CONFIG_GLUSTERFS_XLATOR_OPT
842     /* Without this, if fsync fails for a recoverable reason (for instance,
843      * ENOSPC), gluster will dump its cache, preventing retries.  This means
844      * almost certain data loss.  Not all gluster versions support the
845      * 'resync-failed-syncs-after-fsync' key value, but there is no way to
846      * discover during runtime if it is supported (this api returns success for
847      * unknown key/value pairs) */
848     ret = glfs_set_xlator_option(s->glfs, "*-write-behind",
849                                           "resync-failed-syncs-after-fsync",
850                                           "on");
851     if (ret < 0) {
852         error_setg_errno(errp, errno, "Unable to set xlator key/value pair");
853         ret = -errno;
854         goto out;
855     }
856 #endif
857 
858     qemu_gluster_parse_flags(bdrv_flags, &open_flags);
859 
860     s->fd = glfs_open(s->glfs, gconf->path, open_flags);
861     ret = s->fd ? 0 : -errno;
862 
863     if (ret == -EACCES || ret == -EROFS) {
864         /* Try to degrade to read-only, but if it doesn't work, still use the
865          * normal error message. */
866         if (bdrv_apply_auto_read_only(bs, NULL, NULL) == 0) {
867             open_flags = (open_flags & ~O_RDWR) | O_RDONLY;
868             s->fd = glfs_open(s->glfs, gconf->path, open_flags);
869             ret = s->fd ? 0 : -errno;
870         }
871     }
872 
873     s->supports_seek_data = qemu_gluster_test_seek(s->fd);
874 
875 out:
876     qemu_opts_del(opts);
877     qapi_free_BlockdevOptionsGluster(gconf);
878     if (!ret) {
879         return ret;
880     }
881     g_free(s->logfile);
882     if (s->fd) {
883         glfs_close(s->fd);
884     }
885 
886     glfs_clear_preopened(s->glfs);
887 
888     return ret;
889 }
890 
891 static void qemu_gluster_refresh_limits(BlockDriverState *bs, Error **errp)
892 {
893     bs->bl.max_transfer = GLUSTER_MAX_TRANSFER;
894     bs->bl.max_pdiscard = SIZE_MAX;
895 }
896 
897 static int qemu_gluster_reopen_prepare(BDRVReopenState *state,
898                                        BlockReopenQueue *queue, Error **errp)
899 {
900     int ret = 0;
901     BDRVGlusterState *s;
902     BDRVGlusterReopenState *reop_s;
903     BlockdevOptionsGluster *gconf;
904     int open_flags = 0;
905 
906     assert(state != NULL);
907     assert(state->bs != NULL);
908 
909     s = state->bs->opaque;
910 
911     state->opaque = g_new0(BDRVGlusterReopenState, 1);
912     reop_s = state->opaque;
913 
914     qemu_gluster_parse_flags(state->flags, &open_flags);
915 
916     gconf = g_new0(BlockdevOptionsGluster, 1);
917     gconf->debug = s->debug;
918     gconf->has_debug = true;
919     gconf->logfile = g_strdup(s->logfile);
920     gconf->has_logfile = true;
921 
922     /*
923      * If 'state->bs->exact_filename' is empty, 'state->options' should contain
924      * the JSON parameters already parsed.
925      */
926     if (state->bs->exact_filename[0] != '\0') {
927         reop_s->glfs = qemu_gluster_init(gconf, state->bs->exact_filename, NULL,
928                                          errp);
929     } else {
930         reop_s->glfs = qemu_gluster_init(gconf, NULL, state->options, errp);
931     }
932     if (reop_s->glfs == NULL) {
933         ret = -errno;
934         goto exit;
935     }
936 
937 #ifdef CONFIG_GLUSTERFS_XLATOR_OPT
938     ret = glfs_set_xlator_option(reop_s->glfs, "*-write-behind",
939                                  "resync-failed-syncs-after-fsync", "on");
940     if (ret < 0) {
941         error_setg_errno(errp, errno, "Unable to set xlator key/value pair");
942         ret = -errno;
943         goto exit;
944     }
945 #endif
946 
947     reop_s->fd = glfs_open(reop_s->glfs, gconf->path, open_flags);
948     if (reop_s->fd == NULL) {
949         /* reops->glfs will be cleaned up in _abort */
950         ret = -errno;
951         goto exit;
952     }
953 
954 exit:
955     /* state->opaque will be freed in either the _abort or _commit */
956     qapi_free_BlockdevOptionsGluster(gconf);
957     return ret;
958 }
959 
960 static void qemu_gluster_reopen_commit(BDRVReopenState *state)
961 {
962     BDRVGlusterReopenState *reop_s = state->opaque;
963     BDRVGlusterState *s = state->bs->opaque;
964 
965 
966     /* close the old */
967     if (s->fd) {
968         glfs_close(s->fd);
969     }
970 
971     glfs_clear_preopened(s->glfs);
972 
973     /* use the newly opened image / connection */
974     s->fd         = reop_s->fd;
975     s->glfs       = reop_s->glfs;
976 
977     g_free(state->opaque);
978     state->opaque = NULL;
979 
980     return;
981 }
982 
983 
984 static void qemu_gluster_reopen_abort(BDRVReopenState *state)
985 {
986     BDRVGlusterReopenState *reop_s = state->opaque;
987 
988     if (reop_s == NULL) {
989         return;
990     }
991 
992     if (reop_s->fd) {
993         glfs_close(reop_s->fd);
994     }
995 
996     glfs_clear_preopened(reop_s->glfs);
997 
998     g_free(state->opaque);
999     state->opaque = NULL;
1000 
1001     return;
1002 }
1003 
1004 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1005 static coroutine_fn int qemu_gluster_co_pwrite_zeroes(BlockDriverState *bs,
1006                                                       int64_t offset,
1007                                                       int64_t bytes,
1008                                                       BdrvRequestFlags flags)
1009 {
1010     int ret;
1011     GlusterAIOCB acb;
1012     BDRVGlusterState *s = bs->opaque;
1013 
1014     acb.size = bytes;
1015     acb.ret = 0;
1016     acb.coroutine = qemu_coroutine_self();
1017     acb.aio_context = bdrv_get_aio_context(bs);
1018 
1019     ret = glfs_zerofill_async(s->fd, offset, bytes, gluster_finish_aiocb, &acb);
1020     if (ret < 0) {
1021         return -errno;
1022     }
1023 
1024     qemu_coroutine_yield();
1025     return acb.ret;
1026 }
1027 #endif
1028 
1029 static int qemu_gluster_do_truncate(struct glfs_fd *fd, int64_t offset,
1030                                     PreallocMode prealloc, Error **errp)
1031 {
1032     int64_t current_length;
1033 
1034     current_length = glfs_lseek(fd, 0, SEEK_END);
1035     if (current_length < 0) {
1036         error_setg_errno(errp, errno, "Failed to determine current size");
1037         return -errno;
1038     }
1039 
1040     if (current_length > offset && prealloc != PREALLOC_MODE_OFF) {
1041         error_setg(errp, "Cannot use preallocation for shrinking files");
1042         return -ENOTSUP;
1043     }
1044 
1045     if (current_length == offset) {
1046         return 0;
1047     }
1048 
1049     switch (prealloc) {
1050 #ifdef CONFIG_GLUSTERFS_FALLOCATE
1051     case PREALLOC_MODE_FALLOC:
1052         if (glfs_fallocate(fd, 0, current_length, offset - current_length)) {
1053             error_setg_errno(errp, errno, "Could not preallocate data");
1054             return -errno;
1055         }
1056         break;
1057 #endif /* CONFIG_GLUSTERFS_FALLOCATE */
1058 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1059     case PREALLOC_MODE_FULL:
1060         if (glfs_ftruncate(fd, offset)) {
1061             error_setg_errno(errp, errno, "Could not resize file");
1062             return -errno;
1063         }
1064         if (glfs_zerofill(fd, current_length, offset - current_length)) {
1065             error_setg_errno(errp, errno, "Could not zerofill the new area");
1066             return -errno;
1067         }
1068         break;
1069 #endif /* CONFIG_GLUSTERFS_ZEROFILL */
1070     case PREALLOC_MODE_OFF:
1071         if (glfs_ftruncate(fd, offset)) {
1072             error_setg_errno(errp, errno, "Could not resize file");
1073             return -errno;
1074         }
1075         break;
1076     default:
1077         error_setg(errp, "Unsupported preallocation mode: %s",
1078                    PreallocMode_str(prealloc));
1079         return -EINVAL;
1080     }
1081 
1082     return 0;
1083 }
1084 
1085 static int qemu_gluster_co_create(BlockdevCreateOptions *options,
1086                                   Error **errp)
1087 {
1088     BlockdevCreateOptionsGluster *opts = &options->u.gluster;
1089     struct glfs *glfs;
1090     struct glfs_fd *fd = NULL;
1091     int ret = 0;
1092 
1093     assert(options->driver == BLOCKDEV_DRIVER_GLUSTER);
1094 
1095     glfs = qemu_gluster_glfs_init(opts->location, errp);
1096     if (!glfs) {
1097         ret = -errno;
1098         goto out;
1099     }
1100 
1101     fd = glfs_creat(glfs, opts->location->path,
1102                     O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, S_IRUSR | S_IWUSR);
1103     if (!fd) {
1104         ret = -errno;
1105         goto out;
1106     }
1107 
1108     ret = qemu_gluster_do_truncate(fd, opts->size, opts->preallocation, errp);
1109 
1110 out:
1111     if (fd) {
1112         if (glfs_close(fd) != 0 && ret == 0) {
1113             ret = -errno;
1114         }
1115     }
1116     glfs_clear_preopened(glfs);
1117     return ret;
1118 }
1119 
1120 static int coroutine_fn qemu_gluster_co_create_opts(BlockDriver *drv,
1121                                                     const char *filename,
1122                                                     QemuOpts *opts,
1123                                                     Error **errp)
1124 {
1125     BlockdevCreateOptions *options;
1126     BlockdevCreateOptionsGluster *gopts;
1127     BlockdevOptionsGluster *gconf;
1128     char *tmp = NULL;
1129     Error *local_err = NULL;
1130     int ret;
1131 
1132     options = g_new0(BlockdevCreateOptions, 1);
1133     options->driver = BLOCKDEV_DRIVER_GLUSTER;
1134     gopts = &options->u.gluster;
1135 
1136     gconf = g_new0(BlockdevOptionsGluster, 1);
1137     gopts->location = gconf;
1138 
1139     gopts->size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
1140                            BDRV_SECTOR_SIZE);
1141 
1142     tmp = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
1143     gopts->preallocation = qapi_enum_parse(&PreallocMode_lookup, tmp,
1144                                            PREALLOC_MODE_OFF, &local_err);
1145     g_free(tmp);
1146     if (local_err) {
1147         error_propagate(errp, local_err);
1148         ret = -EINVAL;
1149         goto fail;
1150     }
1151 
1152     gconf->debug = qemu_opt_get_number_del(opts, GLUSTER_OPT_DEBUG,
1153                                            GLUSTER_DEBUG_DEFAULT);
1154     if (gconf->debug < 0) {
1155         gconf->debug = 0;
1156     } else if (gconf->debug > GLUSTER_DEBUG_MAX) {
1157         gconf->debug = GLUSTER_DEBUG_MAX;
1158     }
1159     gconf->has_debug = true;
1160 
1161     gconf->logfile = qemu_opt_get_del(opts, GLUSTER_OPT_LOGFILE);
1162     if (!gconf->logfile) {
1163         gconf->logfile = g_strdup(GLUSTER_LOGFILE_DEFAULT);
1164     }
1165     gconf->has_logfile = true;
1166 
1167     ret = qemu_gluster_parse(gconf, filename, NULL, errp);
1168     if (ret < 0) {
1169         goto fail;
1170     }
1171 
1172     ret = qemu_gluster_co_create(options, errp);
1173     if (ret < 0) {
1174         goto fail;
1175     }
1176 
1177     ret = 0;
1178 fail:
1179     qapi_free_BlockdevCreateOptions(options);
1180     return ret;
1181 }
1182 
1183 static coroutine_fn int qemu_gluster_co_rw(BlockDriverState *bs,
1184                                            int64_t sector_num, int nb_sectors,
1185                                            QEMUIOVector *qiov, int write)
1186 {
1187     int ret;
1188     GlusterAIOCB acb;
1189     BDRVGlusterState *s = bs->opaque;
1190     size_t size = nb_sectors * BDRV_SECTOR_SIZE;
1191     off_t offset = sector_num * BDRV_SECTOR_SIZE;
1192 
1193     acb.size = size;
1194     acb.ret = 0;
1195     acb.coroutine = qemu_coroutine_self();
1196     acb.aio_context = bdrv_get_aio_context(bs);
1197 
1198     if (write) {
1199         ret = glfs_pwritev_async(s->fd, qiov->iov, qiov->niov, offset, 0,
1200                                  gluster_finish_aiocb, &acb);
1201     } else {
1202         ret = glfs_preadv_async(s->fd, qiov->iov, qiov->niov, offset, 0,
1203                                 gluster_finish_aiocb, &acb);
1204     }
1205 
1206     if (ret < 0) {
1207         return -errno;
1208     }
1209 
1210     qemu_coroutine_yield();
1211     return acb.ret;
1212 }
1213 
1214 static coroutine_fn int qemu_gluster_co_truncate(BlockDriverState *bs,
1215                                                  int64_t offset,
1216                                                  bool exact,
1217                                                  PreallocMode prealloc,
1218                                                  BdrvRequestFlags flags,
1219                                                  Error **errp)
1220 {
1221     BDRVGlusterState *s = bs->opaque;
1222     return qemu_gluster_do_truncate(s->fd, offset, prealloc, errp);
1223 }
1224 
1225 static coroutine_fn int qemu_gluster_co_readv(BlockDriverState *bs,
1226                                               int64_t sector_num,
1227                                               int nb_sectors,
1228                                               QEMUIOVector *qiov)
1229 {
1230     return qemu_gluster_co_rw(bs, sector_num, nb_sectors, qiov, 0);
1231 }
1232 
1233 static coroutine_fn int qemu_gluster_co_writev(BlockDriverState *bs,
1234                                                int64_t sector_num,
1235                                                int nb_sectors,
1236                                                QEMUIOVector *qiov,
1237                                                int flags)
1238 {
1239     assert(!flags);
1240     return qemu_gluster_co_rw(bs, sector_num, nb_sectors, qiov, 1);
1241 }
1242 
1243 static void qemu_gluster_close(BlockDriverState *bs)
1244 {
1245     BDRVGlusterState *s = bs->opaque;
1246 
1247     g_free(s->logfile);
1248     if (s->fd) {
1249         glfs_close(s->fd);
1250         s->fd = NULL;
1251     }
1252     glfs_clear_preopened(s->glfs);
1253 }
1254 
1255 static coroutine_fn int qemu_gluster_co_flush_to_disk(BlockDriverState *bs)
1256 {
1257     int ret;
1258     GlusterAIOCB acb;
1259     BDRVGlusterState *s = bs->opaque;
1260 
1261     acb.size = 0;
1262     acb.ret = 0;
1263     acb.coroutine = qemu_coroutine_self();
1264     acb.aio_context = bdrv_get_aio_context(bs);
1265 
1266     ret = glfs_fsync_async(s->fd, gluster_finish_aiocb, &acb);
1267     if (ret < 0) {
1268         ret = -errno;
1269         goto error;
1270     }
1271 
1272     qemu_coroutine_yield();
1273     if (acb.ret < 0) {
1274         ret = acb.ret;
1275         goto error;
1276     }
1277 
1278     return acb.ret;
1279 
1280 error:
1281     /* Some versions of Gluster (3.5.6 -> 3.5.8?) will not retain its cache
1282      * after a fsync failure, so we have no way of allowing the guest to safely
1283      * continue.  Gluster versions prior to 3.5.6 don't retain the cache
1284      * either, but will invalidate the fd on error, so this is again our only
1285      * option.
1286      *
1287      * The 'resync-failed-syncs-after-fsync' xlator option for the
1288      * write-behind cache will cause later gluster versions to retain its
1289      * cache after error, so long as the fd remains open.  However, we
1290      * currently have no way of knowing if this option is supported.
1291      *
1292      * TODO: Once gluster provides a way for us to determine if the option
1293      * is supported, bypass the closure and setting drv to NULL.  */
1294     qemu_gluster_close(bs);
1295     bs->drv = NULL;
1296     return ret;
1297 }
1298 
1299 #ifdef CONFIG_GLUSTERFS_DISCARD
1300 static coroutine_fn int qemu_gluster_co_pdiscard(BlockDriverState *bs,
1301                                                  int64_t offset, int64_t bytes)
1302 {
1303     int ret;
1304     GlusterAIOCB acb;
1305     BDRVGlusterState *s = bs->opaque;
1306 
1307     assert(bytes <= SIZE_MAX); /* rely on max_pdiscard */
1308 
1309     acb.size = 0;
1310     acb.ret = 0;
1311     acb.coroutine = qemu_coroutine_self();
1312     acb.aio_context = bdrv_get_aio_context(bs);
1313 
1314     ret = glfs_discard_async(s->fd, offset, bytes, gluster_finish_aiocb, &acb);
1315     if (ret < 0) {
1316         return -errno;
1317     }
1318 
1319     qemu_coroutine_yield();
1320     return acb.ret;
1321 }
1322 #endif
1323 
1324 static int64_t qemu_gluster_getlength(BlockDriverState *bs)
1325 {
1326     BDRVGlusterState *s = bs->opaque;
1327     int64_t ret;
1328 
1329     ret = glfs_lseek(s->fd, 0, SEEK_END);
1330     if (ret < 0) {
1331         return -errno;
1332     } else {
1333         return ret;
1334     }
1335 }
1336 
1337 static int64_t qemu_gluster_allocated_file_size(BlockDriverState *bs)
1338 {
1339     BDRVGlusterState *s = bs->opaque;
1340     struct stat st;
1341     int ret;
1342 
1343     ret = glfs_fstat(s->fd, &st);
1344     if (ret < 0) {
1345         return -errno;
1346     } else {
1347         return st.st_blocks * 512;
1348     }
1349 }
1350 
1351 /*
1352  * Find allocation range in @bs around offset @start.
1353  * May change underlying file descriptor's file offset.
1354  * If @start is not in a hole, store @start in @data, and the
1355  * beginning of the next hole in @hole, and return 0.
1356  * If @start is in a non-trailing hole, store @start in @hole and the
1357  * beginning of the next non-hole in @data, and return 0.
1358  * If @start is in a trailing hole or beyond EOF, return -ENXIO.
1359  * If we can't find out, return a negative errno other than -ENXIO.
1360  *
1361  * (Shamefully copied from file-posix.c, only minuscule adaptions.)
1362  */
1363 static int find_allocation(BlockDriverState *bs, off_t start,
1364                            off_t *data, off_t *hole)
1365 {
1366     BDRVGlusterState *s = bs->opaque;
1367 
1368     if (!s->supports_seek_data) {
1369         goto exit;
1370     }
1371 
1372 #if defined SEEK_HOLE && defined SEEK_DATA
1373     off_t offs;
1374 
1375     /*
1376      * SEEK_DATA cases:
1377      * D1. offs == start: start is in data
1378      * D2. offs > start: start is in a hole, next data at offs
1379      * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
1380      *                              or start is beyond EOF
1381      *     If the latter happens, the file has been truncated behind
1382      *     our back since we opened it.  All bets are off then.
1383      *     Treating like a trailing hole is simplest.
1384      * D4. offs < 0, errno != ENXIO: we learned nothing
1385      */
1386     offs = glfs_lseek(s->fd, start, SEEK_DATA);
1387     if (offs < 0) {
1388         return -errno;          /* D3 or D4 */
1389     }
1390 
1391     if (offs < start) {
1392         /* This is not a valid return by lseek().  We are safe to just return
1393          * -EIO in this case, and we'll treat it like D4. Unfortunately some
1394          *  versions of gluster server will return offs < start, so an assert
1395          *  here will unnecessarily abort QEMU. */
1396         return -EIO;
1397     }
1398 
1399     if (offs > start) {
1400         /* D2: in hole, next data at offs */
1401         *hole = start;
1402         *data = offs;
1403         return 0;
1404     }
1405 
1406     /* D1: in data, end not yet known */
1407 
1408     /*
1409      * SEEK_HOLE cases:
1410      * H1. offs == start: start is in a hole
1411      *     If this happens here, a hole has been dug behind our back
1412      *     since the previous lseek().
1413      * H2. offs > start: either start is in data, next hole at offs,
1414      *                   or start is in trailing hole, EOF at offs
1415      *     Linux treats trailing holes like any other hole: offs ==
1416      *     start.  Solaris seeks to EOF instead: offs > start (blech).
1417      *     If that happens here, a hole has been dug behind our back
1418      *     since the previous lseek().
1419      * H3. offs < 0, errno = ENXIO: start is beyond EOF
1420      *     If this happens, the file has been truncated behind our
1421      *     back since we opened it.  Treat it like a trailing hole.
1422      * H4. offs < 0, errno != ENXIO: we learned nothing
1423      *     Pretend we know nothing at all, i.e. "forget" about D1.
1424      */
1425     offs = glfs_lseek(s->fd, start, SEEK_HOLE);
1426     if (offs < 0) {
1427         return -errno;          /* D1 and (H3 or H4) */
1428     }
1429 
1430     if (offs < start) {
1431         /* This is not a valid return by lseek().  We are safe to just return
1432          * -EIO in this case, and we'll treat it like H4. Unfortunately some
1433          *  versions of gluster server will return offs < start, so an assert
1434          *  here will unnecessarily abort QEMU. */
1435         return -EIO;
1436     }
1437 
1438     if (offs > start) {
1439         /*
1440          * D1 and H2: either in data, next hole at offs, or it was in
1441          * data but is now in a trailing hole.  In the latter case,
1442          * all bets are off.  Treating it as if it there was data all
1443          * the way to EOF is safe, so simply do that.
1444          */
1445         *data = start;
1446         *hole = offs;
1447         return 0;
1448     }
1449 
1450     /* D1 and H1 */
1451     return -EBUSY;
1452 #endif
1453 
1454 exit:
1455     return -ENOTSUP;
1456 }
1457 
1458 /*
1459  * Returns the allocation status of the specified offset.
1460  *
1461  * The block layer guarantees 'offset' and 'bytes' are within bounds.
1462  *
1463  * 'pnum' is set to the number of bytes (including and immediately following
1464  * the specified offset) that are known to be in the same
1465  * allocated/unallocated state.
1466  *
1467  * 'bytes' is a soft cap for 'pnum'.  If the information is free, 'pnum' may
1468  * well exceed it.
1469  *
1470  * (Based on raw_co_block_status() from file-posix.c.)
1471  */
1472 static int coroutine_fn qemu_gluster_co_block_status(BlockDriverState *bs,
1473                                                      bool want_zero,
1474                                                      int64_t offset,
1475                                                      int64_t bytes,
1476                                                      int64_t *pnum,
1477                                                      int64_t *map,
1478                                                      BlockDriverState **file)
1479 {
1480     BDRVGlusterState *s = bs->opaque;
1481     off_t data = 0, hole = 0;
1482     int ret = -EINVAL;
1483 
1484     assert(QEMU_IS_ALIGNED(offset | bytes, bs->bl.request_alignment));
1485 
1486     if (!s->fd) {
1487         return ret;
1488     }
1489 
1490     if (!want_zero) {
1491         *pnum = bytes;
1492         *map = offset;
1493         *file = bs;
1494         return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
1495     }
1496 
1497     ret = find_allocation(bs, offset, &data, &hole);
1498     if (ret == -ENXIO) {
1499         /* Trailing hole */
1500         *pnum = bytes;
1501         ret = BDRV_BLOCK_ZERO;
1502     } else if (ret < 0) {
1503         /* No info available, so pretend there are no holes */
1504         *pnum = bytes;
1505         ret = BDRV_BLOCK_DATA;
1506     } else if (data == offset) {
1507         /* On a data extent, compute bytes to the end of the extent,
1508          * possibly including a partial sector at EOF. */
1509         *pnum = hole - offset;
1510 
1511         /*
1512          * We are not allowed to return partial sectors, though, so
1513          * round up if necessary.
1514          */
1515         if (!QEMU_IS_ALIGNED(*pnum, bs->bl.request_alignment)) {
1516             int64_t file_length = qemu_gluster_getlength(bs);
1517             if (file_length > 0) {
1518                 /* Ignore errors, this is just a safeguard */
1519                 assert(hole == file_length);
1520             }
1521             *pnum = ROUND_UP(*pnum, bs->bl.request_alignment);
1522         }
1523 
1524         ret = BDRV_BLOCK_DATA;
1525     } else {
1526         /* On a hole, compute bytes to the beginning of the next extent.  */
1527         assert(hole == offset);
1528         *pnum = data - offset;
1529         ret = BDRV_BLOCK_ZERO;
1530     }
1531 
1532     *map = offset;
1533     *file = bs;
1534 
1535     return ret | BDRV_BLOCK_OFFSET_VALID;
1536 }
1537 
1538 
1539 static const char *const gluster_strong_open_opts[] = {
1540     GLUSTER_OPT_VOLUME,
1541     GLUSTER_OPT_PATH,
1542     GLUSTER_OPT_TYPE,
1543     GLUSTER_OPT_SERVER_PATTERN,
1544     GLUSTER_OPT_HOST,
1545     GLUSTER_OPT_PORT,
1546     GLUSTER_OPT_TO,
1547     GLUSTER_OPT_IPV4,
1548     GLUSTER_OPT_IPV6,
1549     GLUSTER_OPT_SOCKET,
1550 
1551     NULL
1552 };
1553 
1554 static BlockDriver bdrv_gluster = {
1555     .format_name                  = "gluster",
1556     .protocol_name                = "gluster",
1557     .instance_size                = sizeof(BDRVGlusterState),
1558     .bdrv_needs_filename          = false,
1559     .bdrv_file_open               = qemu_gluster_open,
1560     .bdrv_reopen_prepare          = qemu_gluster_reopen_prepare,
1561     .bdrv_reopen_commit           = qemu_gluster_reopen_commit,
1562     .bdrv_reopen_abort            = qemu_gluster_reopen_abort,
1563     .bdrv_close                   = qemu_gluster_close,
1564     .bdrv_co_create               = qemu_gluster_co_create,
1565     .bdrv_co_create_opts          = qemu_gluster_co_create_opts,
1566     .bdrv_getlength               = qemu_gluster_getlength,
1567     .bdrv_get_allocated_file_size = qemu_gluster_allocated_file_size,
1568     .bdrv_co_truncate             = qemu_gluster_co_truncate,
1569     .bdrv_co_readv                = qemu_gluster_co_readv,
1570     .bdrv_co_writev               = qemu_gluster_co_writev,
1571     .bdrv_co_flush_to_disk        = qemu_gluster_co_flush_to_disk,
1572 #ifdef CONFIG_GLUSTERFS_DISCARD
1573     .bdrv_co_pdiscard             = qemu_gluster_co_pdiscard,
1574 #endif
1575 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1576     .bdrv_co_pwrite_zeroes        = qemu_gluster_co_pwrite_zeroes,
1577 #endif
1578     .bdrv_co_block_status         = qemu_gluster_co_block_status,
1579     .bdrv_refresh_limits          = qemu_gluster_refresh_limits,
1580     .create_opts                  = &qemu_gluster_create_opts,
1581     .strong_runtime_opts          = gluster_strong_open_opts,
1582 };
1583 
1584 static BlockDriver bdrv_gluster_tcp = {
1585     .format_name                  = "gluster",
1586     .protocol_name                = "gluster+tcp",
1587     .instance_size                = sizeof(BDRVGlusterState),
1588     .bdrv_needs_filename          = false,
1589     .bdrv_file_open               = qemu_gluster_open,
1590     .bdrv_reopen_prepare          = qemu_gluster_reopen_prepare,
1591     .bdrv_reopen_commit           = qemu_gluster_reopen_commit,
1592     .bdrv_reopen_abort            = qemu_gluster_reopen_abort,
1593     .bdrv_close                   = qemu_gluster_close,
1594     .bdrv_co_create               = qemu_gluster_co_create,
1595     .bdrv_co_create_opts          = qemu_gluster_co_create_opts,
1596     .bdrv_getlength               = qemu_gluster_getlength,
1597     .bdrv_get_allocated_file_size = qemu_gluster_allocated_file_size,
1598     .bdrv_co_truncate             = qemu_gluster_co_truncate,
1599     .bdrv_co_readv                = qemu_gluster_co_readv,
1600     .bdrv_co_writev               = qemu_gluster_co_writev,
1601     .bdrv_co_flush_to_disk        = qemu_gluster_co_flush_to_disk,
1602 #ifdef CONFIG_GLUSTERFS_DISCARD
1603     .bdrv_co_pdiscard             = qemu_gluster_co_pdiscard,
1604 #endif
1605 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1606     .bdrv_co_pwrite_zeroes        = qemu_gluster_co_pwrite_zeroes,
1607 #endif
1608     .bdrv_co_block_status         = qemu_gluster_co_block_status,
1609     .bdrv_refresh_limits          = qemu_gluster_refresh_limits,
1610     .create_opts                  = &qemu_gluster_create_opts,
1611     .strong_runtime_opts          = gluster_strong_open_opts,
1612 };
1613 
1614 static BlockDriver bdrv_gluster_unix = {
1615     .format_name                  = "gluster",
1616     .protocol_name                = "gluster+unix",
1617     .instance_size                = sizeof(BDRVGlusterState),
1618     .bdrv_needs_filename          = true,
1619     .bdrv_file_open               = qemu_gluster_open,
1620     .bdrv_reopen_prepare          = qemu_gluster_reopen_prepare,
1621     .bdrv_reopen_commit           = qemu_gluster_reopen_commit,
1622     .bdrv_reopen_abort            = qemu_gluster_reopen_abort,
1623     .bdrv_close                   = qemu_gluster_close,
1624     .bdrv_co_create               = qemu_gluster_co_create,
1625     .bdrv_co_create_opts          = qemu_gluster_co_create_opts,
1626     .bdrv_getlength               = qemu_gluster_getlength,
1627     .bdrv_get_allocated_file_size = qemu_gluster_allocated_file_size,
1628     .bdrv_co_truncate             = qemu_gluster_co_truncate,
1629     .bdrv_co_readv                = qemu_gluster_co_readv,
1630     .bdrv_co_writev               = qemu_gluster_co_writev,
1631     .bdrv_co_flush_to_disk        = qemu_gluster_co_flush_to_disk,
1632 #ifdef CONFIG_GLUSTERFS_DISCARD
1633     .bdrv_co_pdiscard             = qemu_gluster_co_pdiscard,
1634 #endif
1635 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1636     .bdrv_co_pwrite_zeroes        = qemu_gluster_co_pwrite_zeroes,
1637 #endif
1638     .bdrv_co_block_status         = qemu_gluster_co_block_status,
1639     .bdrv_refresh_limits          = qemu_gluster_refresh_limits,
1640     .create_opts                  = &qemu_gluster_create_opts,
1641     .strong_runtime_opts          = gluster_strong_open_opts,
1642 };
1643 
1644 /* rdma is deprecated (actually never supported for volfile fetch).
1645  * Let's maintain it for the protocol compatibility, to make sure things
1646  * won't break immediately. For now, gluster+rdma will fall back to gluster+tcp
1647  * protocol with a warning.
1648  * TODO: remove gluster+rdma interface support
1649  */
1650 static BlockDriver bdrv_gluster_rdma = {
1651     .format_name                  = "gluster",
1652     .protocol_name                = "gluster+rdma",
1653     .instance_size                = sizeof(BDRVGlusterState),
1654     .bdrv_needs_filename          = true,
1655     .bdrv_file_open               = qemu_gluster_open,
1656     .bdrv_reopen_prepare          = qemu_gluster_reopen_prepare,
1657     .bdrv_reopen_commit           = qemu_gluster_reopen_commit,
1658     .bdrv_reopen_abort            = qemu_gluster_reopen_abort,
1659     .bdrv_close                   = qemu_gluster_close,
1660     .bdrv_co_create               = qemu_gluster_co_create,
1661     .bdrv_co_create_opts          = qemu_gluster_co_create_opts,
1662     .bdrv_getlength               = qemu_gluster_getlength,
1663     .bdrv_get_allocated_file_size = qemu_gluster_allocated_file_size,
1664     .bdrv_co_truncate             = qemu_gluster_co_truncate,
1665     .bdrv_co_readv                = qemu_gluster_co_readv,
1666     .bdrv_co_writev               = qemu_gluster_co_writev,
1667     .bdrv_co_flush_to_disk        = qemu_gluster_co_flush_to_disk,
1668 #ifdef CONFIG_GLUSTERFS_DISCARD
1669     .bdrv_co_pdiscard             = qemu_gluster_co_pdiscard,
1670 #endif
1671 #ifdef CONFIG_GLUSTERFS_ZEROFILL
1672     .bdrv_co_pwrite_zeroes        = qemu_gluster_co_pwrite_zeroes,
1673 #endif
1674     .bdrv_co_block_status         = qemu_gluster_co_block_status,
1675     .bdrv_refresh_limits          = qemu_gluster_refresh_limits,
1676     .create_opts                  = &qemu_gluster_create_opts,
1677     .strong_runtime_opts          = gluster_strong_open_opts,
1678 };
1679 
1680 static void bdrv_gluster_init(void)
1681 {
1682     bdrv_register(&bdrv_gluster_rdma);
1683     bdrv_register(&bdrv_gluster_unix);
1684     bdrv_register(&bdrv_gluster_tcp);
1685     bdrv_register(&bdrv_gluster);
1686 }
1687 
1688 block_init(bdrv_gluster_init);
1689