2 * Copyright (C) 2016-2020 Red Hat, Inc.
3 * Copyright (C) 2005 Anthony Liguori <anthony@codemonkey.ws>
5 * Network Block Device Server Side
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; under version 2 of the License.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 #include "qemu/osdep.h"
22 #include "block/export.h"
23 #include "qapi/error.h"
24 #include "qemu/queue.h"
26 #include "nbd-internal.h"
27 #include "qemu/units.h"
29 #define NBD_META_ID_BASE_ALLOCATION 0
30 #define NBD_META_ID_ALLOCATION_DEPTH 1
31 /* Dirty bitmaps use 'NBD_META_ID_DIRTY_BITMAP + i', so keep this id last. */
32 #define NBD_META_ID_DIRTY_BITMAP 2
35 * NBD_MAX_BLOCK_STATUS_EXTENTS: 1 MiB of extents data. An empirical
36 * constant. If an increase is needed, note that the NBD protocol
37 * recommends no larger than 32 mb, so that the client won't consider
38 * the reply as a denial of service attack.
40 #define NBD_MAX_BLOCK_STATUS_EXTENTS (1 * MiB / 8)
42 static int system_errno_to_nbd_errno(int err
)
63 #if ENOTSUP != EOPNOTSUPP
75 /* Definitions for opaque data types */
77 typedef struct NBDRequestData NBDRequestData
;
79 struct NBDRequestData
{
80 QSIMPLEQ_ENTRY(NBDRequestData
) entry
;
93 QTAILQ_HEAD(, NBDClient
) clients
;
94 QTAILQ_ENTRY(NBDExport
) next
;
96 BlockBackend
*eject_notifier_blk
;
97 Notifier eject_notifier
;
99 bool allocation_depth
;
100 BdrvDirtyBitmap
**export_bitmaps
;
101 size_t nr_export_bitmaps
;
104 static QTAILQ_HEAD(, NBDExport
) exports
= QTAILQ_HEAD_INITIALIZER(exports
);
106 /* NBDExportMetaContexts represents a list of contexts to be exported,
107 * as selected by NBD_OPT_SET_META_CONTEXT. Also used for
108 * NBD_OPT_LIST_META_CONTEXT. */
109 typedef struct NBDExportMetaContexts
{
111 size_t count
; /* number of negotiated contexts */
112 bool base_allocation
; /* export base:allocation context (block status) */
113 bool allocation_depth
; /* export qemu:allocation-depth */
115 * export qemu:dirty-bitmap:<export bitmap name>,
116 * sized by exp->nr_export_bitmaps
118 } NBDExportMetaContexts
;
122 void (*close_fn
)(NBDClient
*client
, bool negotiated
);
125 QCryptoTLSCreds
*tlscreds
;
127 QIOChannelSocket
*sioc
; /* The underlying data channel */
128 QIOChannel
*ioc
; /* The current I/O channel which may differ (eg TLS) */
130 Coroutine
*recv_coroutine
;
133 Coroutine
*send_coroutine
;
138 QTAILQ_ENTRY(NBDClient
) next
;
142 uint32_t check_align
; /* If non-zero, check for aligned client requests */
144 bool structured_reply
;
145 NBDExportMetaContexts export_meta
;
147 uint32_t opt
; /* Current option being negotiated */
148 uint32_t optlen
; /* remaining length of data in ioc for the option being
152 static void nbd_client_receive_next_request(NBDClient
*client
);
154 /* Basic flow for negotiation
181 static inline void set_be_option_rep(NBDOptionReply
*rep
, uint32_t option
,
182 uint32_t type
, uint32_t length
)
184 stq_be_p(&rep
->magic
, NBD_REP_MAGIC
);
185 stl_be_p(&rep
->option
, option
);
186 stl_be_p(&rep
->type
, type
);
187 stl_be_p(&rep
->length
, length
);
190 /* Send a reply header, including length, but no payload.
191 * Return -errno on error, 0 on success. */
192 static int nbd_negotiate_send_rep_len(NBDClient
*client
, uint32_t type
,
193 uint32_t len
, Error
**errp
)
197 trace_nbd_negotiate_send_rep_len(client
->opt
, nbd_opt_lookup(client
->opt
),
198 type
, nbd_rep_lookup(type
), len
);
200 assert(len
< NBD_MAX_BUFFER_SIZE
);
202 set_be_option_rep(&rep
, client
->opt
, type
, len
);
203 return nbd_write(client
->ioc
, &rep
, sizeof(rep
), errp
);
206 /* Send a reply header with default 0 length.
207 * Return -errno on error, 0 on success. */
208 static int nbd_negotiate_send_rep(NBDClient
*client
, uint32_t type
,
211 return nbd_negotiate_send_rep_len(client
, type
, 0, errp
);
214 /* Send an error reply.
215 * Return -errno on error, 0 on success. */
216 static int GCC_FMT_ATTR(4, 0)
217 nbd_negotiate_send_rep_verr(NBDClient
*client
, uint32_t type
,
218 Error
**errp
, const char *fmt
, va_list va
)
221 g_autofree
char *msg
= NULL
;
225 msg
= g_strdup_vprintf(fmt
, va
);
227 assert(len
< NBD_MAX_STRING_SIZE
);
228 trace_nbd_negotiate_send_rep_err(msg
);
229 ret
= nbd_negotiate_send_rep_len(client
, type
, len
, errp
);
233 if (nbd_write(client
->ioc
, msg
, len
, errp
) < 0) {
234 error_prepend(errp
, "write failed (error message): ");
242 * Return a malloc'd copy of @name suitable for use in an error reply.
245 nbd_sanitize_name(const char *name
)
247 if (strnlen(name
, 80) < 80) {
248 return g_strdup(name
);
250 /* XXX Should we also try to sanitize any control characters? */
251 return g_strdup_printf("%.80s...", name
);
254 /* Send an error reply.
255 * Return -errno on error, 0 on success. */
256 static int GCC_FMT_ATTR(4, 5)
257 nbd_negotiate_send_rep_err(NBDClient
*client
, uint32_t type
,
258 Error
**errp
, const char *fmt
, ...)
264 ret
= nbd_negotiate_send_rep_verr(client
, type
, errp
, fmt
, va
);
269 /* Drop remainder of the current option, and send a reply with the
270 * given error type and message. Return -errno on read or write
271 * failure; or 0 if connection is still live. */
272 static int GCC_FMT_ATTR(4, 0)
273 nbd_opt_vdrop(NBDClient
*client
, uint32_t type
, Error
**errp
,
274 const char *fmt
, va_list va
)
276 int ret
= nbd_drop(client
->ioc
, client
->optlen
, errp
);
280 ret
= nbd_negotiate_send_rep_verr(client
, type
, errp
, fmt
, va
);
285 static int GCC_FMT_ATTR(4, 5)
286 nbd_opt_drop(NBDClient
*client
, uint32_t type
, Error
**errp
,
287 const char *fmt
, ...)
293 ret
= nbd_opt_vdrop(client
, type
, errp
, fmt
, va
);
299 static int GCC_FMT_ATTR(3, 4)
300 nbd_opt_invalid(NBDClient
*client
, Error
**errp
, const char *fmt
, ...)
306 ret
= nbd_opt_vdrop(client
, NBD_REP_ERR_INVALID
, errp
, fmt
, va
);
312 /* Read size bytes from the unparsed payload of the current option.
313 * If @check_nul, require that no NUL bytes appear in buffer.
314 * Return -errno on I/O error, 0 if option was completely handled by
315 * sending a reply about inconsistent lengths, or 1 on success. */
316 static int nbd_opt_read(NBDClient
*client
, void *buffer
, size_t size
,
317 bool check_nul
, Error
**errp
)
319 if (size
> client
->optlen
) {
320 return nbd_opt_invalid(client
, errp
,
321 "Inconsistent lengths in option %s",
322 nbd_opt_lookup(client
->opt
));
324 client
->optlen
-= size
;
325 if (qio_channel_read_all(client
->ioc
, buffer
, size
, errp
) < 0) {
329 if (check_nul
&& strnlen(buffer
, size
) != size
) {
330 return nbd_opt_invalid(client
, errp
,
331 "Unexpected embedded NUL in option %s",
332 nbd_opt_lookup(client
->opt
));
337 /* Drop size bytes from the unparsed payload of the current option.
338 * Return -errno on I/O error, 0 if option was completely handled by
339 * sending a reply about inconsistent lengths, or 1 on success. */
340 static int nbd_opt_skip(NBDClient
*client
, size_t size
, Error
**errp
)
342 if (size
> client
->optlen
) {
343 return nbd_opt_invalid(client
, errp
,
344 "Inconsistent lengths in option %s",
345 nbd_opt_lookup(client
->opt
));
347 client
->optlen
-= size
;
348 return nbd_drop(client
->ioc
, size
, errp
) < 0 ? -EIO
: 1;
353 * Read a string with the format:
354 * uint32_t len (<= NBD_MAX_STRING_SIZE)
355 * len bytes string (not 0-terminated)
357 * On success, @name will be allocated.
358 * If @length is non-null, it will be set to the actual string length.
360 * Return -errno on I/O error, 0 if option was completely handled by
361 * sending a reply about inconsistent lengths, or 1 on success.
363 static int nbd_opt_read_name(NBDClient
*client
, char **name
, uint32_t *length
,
368 g_autofree
char *local_name
= NULL
;
371 ret
= nbd_opt_read(client
, &len
, sizeof(len
), false, errp
);
375 len
= cpu_to_be32(len
);
377 if (len
> NBD_MAX_STRING_SIZE
) {
378 return nbd_opt_invalid(client
, errp
,
379 "Invalid name length: %" PRIu32
, len
);
382 local_name
= g_malloc(len
+ 1);
383 ret
= nbd_opt_read(client
, local_name
, len
, true, errp
);
387 local_name
[len
] = '\0';
392 *name
= g_steal_pointer(&local_name
);
397 /* Send a single NBD_REP_SERVER reply to NBD_OPT_LIST, including payload.
398 * Return -errno on error, 0 on success. */
399 static int nbd_negotiate_send_rep_list(NBDClient
*client
, NBDExport
*exp
,
403 size_t name_len
, desc_len
;
405 const char *name
= exp
->name
? exp
->name
: "";
406 const char *desc
= exp
->description
? exp
->description
: "";
407 QIOChannel
*ioc
= client
->ioc
;
410 trace_nbd_negotiate_send_rep_list(name
, desc
);
411 name_len
= strlen(name
);
412 desc_len
= strlen(desc
);
413 assert(name_len
<= NBD_MAX_STRING_SIZE
&& desc_len
<= NBD_MAX_STRING_SIZE
);
414 len
= name_len
+ desc_len
+ sizeof(len
);
415 ret
= nbd_negotiate_send_rep_len(client
, NBD_REP_SERVER
, len
, errp
);
420 len
= cpu_to_be32(name_len
);
421 if (nbd_write(ioc
, &len
, sizeof(len
), errp
) < 0) {
422 error_prepend(errp
, "write failed (name length): ");
426 if (nbd_write(ioc
, name
, name_len
, errp
) < 0) {
427 error_prepend(errp
, "write failed (name buffer): ");
431 if (nbd_write(ioc
, desc
, desc_len
, errp
) < 0) {
432 error_prepend(errp
, "write failed (description buffer): ");
439 /* Process the NBD_OPT_LIST command, with a potential series of replies.
440 * Return -errno on error, 0 on success. */
441 static int nbd_negotiate_handle_list(NBDClient
*client
, Error
**errp
)
444 assert(client
->opt
== NBD_OPT_LIST
);
446 /* For each export, send a NBD_REP_SERVER reply. */
447 QTAILQ_FOREACH(exp
, &exports
, next
) {
448 if (nbd_negotiate_send_rep_list(client
, exp
, errp
)) {
452 /* Finish with a NBD_REP_ACK. */
453 return nbd_negotiate_send_rep(client
, NBD_REP_ACK
, errp
);
456 static void nbd_check_meta_export(NBDClient
*client
)
458 if (client
->exp
!= client
->export_meta
.exp
) {
459 client
->export_meta
.count
= 0;
463 /* Send a reply to NBD_OPT_EXPORT_NAME.
464 * Return -errno on error, 0 on success. */
465 static int nbd_negotiate_handle_export_name(NBDClient
*client
, bool no_zeroes
,
469 g_autofree
char *name
= NULL
;
470 char buf
[NBD_REPLY_EXPORT_NAME_SIZE
] = "";
476 [20 .. xx] export name (length bytes)
479 [ 8 .. 9] export flags
480 [10 .. 133] reserved (0) [unless no_zeroes]
482 trace_nbd_negotiate_handle_export_name();
483 if (client
->optlen
> NBD_MAX_STRING_SIZE
) {
484 error_setg(errp
, "Bad length received");
487 name
= g_malloc(client
->optlen
+ 1);
488 if (nbd_read(client
->ioc
, name
, client
->optlen
, "export name", errp
) < 0) {
491 name
[client
->optlen
] = '\0';
494 trace_nbd_negotiate_handle_export_name_request(name
);
496 client
->exp
= nbd_export_find(name
);
498 error_setg(errp
, "export not found");
502 myflags
= client
->exp
->nbdflags
;
503 if (client
->structured_reply
) {
504 myflags
|= NBD_FLAG_SEND_DF
;
506 trace_nbd_negotiate_new_style_size_flags(client
->exp
->size
, myflags
);
507 stq_be_p(buf
, client
->exp
->size
);
508 stw_be_p(buf
+ 8, myflags
);
509 len
= no_zeroes
? 10 : sizeof(buf
);
510 ret
= nbd_write(client
->ioc
, buf
, len
, errp
);
512 error_prepend(errp
, "write failed: ");
516 QTAILQ_INSERT_TAIL(&client
->exp
->clients
, client
, next
);
517 blk_exp_ref(&client
->exp
->common
);
518 nbd_check_meta_export(client
);
523 /* Send a single NBD_REP_INFO, with a buffer @buf of @length bytes.
524 * The buffer does NOT include the info type prefix.
525 * Return -errno on error, 0 if ready to send more. */
526 static int nbd_negotiate_send_info(NBDClient
*client
,
527 uint16_t info
, uint32_t length
, void *buf
,
532 trace_nbd_negotiate_send_info(info
, nbd_info_lookup(info
), length
);
533 rc
= nbd_negotiate_send_rep_len(client
, NBD_REP_INFO
,
534 sizeof(info
) + length
, errp
);
538 info
= cpu_to_be16(info
);
539 if (nbd_write(client
->ioc
, &info
, sizeof(info
), errp
) < 0) {
542 if (nbd_write(client
->ioc
, buf
, length
, errp
) < 0) {
548 /* nbd_reject_length: Handle any unexpected payload.
549 * @fatal requests that we quit talking to the client, even if we are able
550 * to successfully send an error reply.
552 * -errno transmission error occurred or @fatal was requested, errp is set
553 * 0 error message successfully sent to client, errp is not set
555 static int nbd_reject_length(NBDClient
*client
, bool fatal
, Error
**errp
)
559 assert(client
->optlen
);
560 ret
= nbd_opt_invalid(client
, errp
, "option '%s' has unexpected length",
561 nbd_opt_lookup(client
->opt
));
563 error_setg(errp
, "option '%s' has unexpected length",
564 nbd_opt_lookup(client
->opt
));
570 /* Handle NBD_OPT_INFO and NBD_OPT_GO.
571 * Return -errno on error, 0 if ready for next option, and 1 to move
572 * into transmission phase. */
573 static int nbd_negotiate_handle_info(NBDClient
*client
, Error
**errp
)
576 g_autofree
char *name
= NULL
;
580 uint32_t namelen
= 0;
581 bool sendname
= false;
582 bool blocksize
= false;
584 char buf
[sizeof(uint64_t) + sizeof(uint16_t)];
585 uint32_t check_align
= 0;
589 4 bytes: L, name length (can be 0)
591 2 bytes: N, number of requests (can be 0)
592 N * 2 bytes: N requests
594 rc
= nbd_opt_read_name(client
, &name
, &namelen
, errp
);
598 trace_nbd_negotiate_handle_export_name_request(name
);
600 rc
= nbd_opt_read(client
, &requests
, sizeof(requests
), false, errp
);
604 requests
= be16_to_cpu(requests
);
605 trace_nbd_negotiate_handle_info_requests(requests
);
607 rc
= nbd_opt_read(client
, &request
, sizeof(request
), false, errp
);
611 request
= be16_to_cpu(request
);
612 trace_nbd_negotiate_handle_info_request(request
,
613 nbd_info_lookup(request
));
614 /* We care about NBD_INFO_NAME and NBD_INFO_BLOCK_SIZE;
615 * everything else is either a request we don't know or
616 * something we send regardless of request */
621 case NBD_INFO_BLOCK_SIZE
:
626 if (client
->optlen
) {
627 return nbd_reject_length(client
, false, errp
);
630 exp
= nbd_export_find(name
);
632 g_autofree
char *sane_name
= nbd_sanitize_name(name
);
634 return nbd_negotiate_send_rep_err(client
, NBD_REP_ERR_UNKNOWN
,
635 errp
, "export '%s' not present",
639 /* Don't bother sending NBD_INFO_NAME unless client requested it */
641 rc
= nbd_negotiate_send_info(client
, NBD_INFO_NAME
, namelen
, name
,
648 /* Send NBD_INFO_DESCRIPTION only if available, regardless of
650 if (exp
->description
) {
651 size_t len
= strlen(exp
->description
);
653 assert(len
<= NBD_MAX_STRING_SIZE
);
654 rc
= nbd_negotiate_send_info(client
, NBD_INFO_DESCRIPTION
,
655 len
, exp
->description
, errp
);
661 /* Send NBD_INFO_BLOCK_SIZE always, but tweak the minimum size
662 * according to whether the client requested it, and according to
663 * whether this is OPT_INFO or OPT_GO. */
664 /* minimum - 1 for back-compat, or actual if client will obey it. */
665 if (client
->opt
== NBD_OPT_INFO
|| blocksize
) {
666 check_align
= sizes
[0] = blk_get_request_alignment(exp
->common
.blk
);
670 assert(sizes
[0] <= NBD_MAX_BUFFER_SIZE
);
671 /* preferred - Hard-code to 4096 for now.
672 * TODO: is blk_bs(blk)->bl.opt_transfer appropriate? */
673 sizes
[1] = MAX(4096, sizes
[0]);
674 /* maximum - At most 32M, but smaller as appropriate. */
675 sizes
[2] = MIN(blk_get_max_transfer(exp
->common
.blk
), NBD_MAX_BUFFER_SIZE
);
676 trace_nbd_negotiate_handle_info_block_size(sizes
[0], sizes
[1], sizes
[2]);
677 sizes
[0] = cpu_to_be32(sizes
[0]);
678 sizes
[1] = cpu_to_be32(sizes
[1]);
679 sizes
[2] = cpu_to_be32(sizes
[2]);
680 rc
= nbd_negotiate_send_info(client
, NBD_INFO_BLOCK_SIZE
,
681 sizeof(sizes
), sizes
, errp
);
686 /* Send NBD_INFO_EXPORT always */
687 myflags
= exp
->nbdflags
;
688 if (client
->structured_reply
) {
689 myflags
|= NBD_FLAG_SEND_DF
;
691 trace_nbd_negotiate_new_style_size_flags(exp
->size
, myflags
);
692 stq_be_p(buf
, exp
->size
);
693 stw_be_p(buf
+ 8, myflags
);
694 rc
= nbd_negotiate_send_info(client
, NBD_INFO_EXPORT
,
695 sizeof(buf
), buf
, errp
);
701 * If the client is just asking for NBD_OPT_INFO, but forgot to
702 * request block sizes in a situation that would impact
703 * performance, then return an error. But for NBD_OPT_GO, we
704 * tolerate all clients, regardless of alignments.
706 if (client
->opt
== NBD_OPT_INFO
&& !blocksize
&&
707 blk_get_request_alignment(exp
->common
.blk
) > 1) {
708 return nbd_negotiate_send_rep_err(client
,
709 NBD_REP_ERR_BLOCK_SIZE_REQD
,
711 "request NBD_INFO_BLOCK_SIZE to "
716 rc
= nbd_negotiate_send_rep(client
, NBD_REP_ACK
, errp
);
721 if (client
->opt
== NBD_OPT_GO
) {
723 client
->check_align
= check_align
;
724 QTAILQ_INSERT_TAIL(&client
->exp
->clients
, client
, next
);
725 blk_exp_ref(&client
->exp
->common
);
726 nbd_check_meta_export(client
);
733 /* Handle NBD_OPT_STARTTLS. Return NULL to drop connection, or else the
734 * new channel for all further (now-encrypted) communication. */
735 static QIOChannel
*nbd_negotiate_handle_starttls(NBDClient
*client
,
740 struct NBDTLSHandshakeData data
= { 0 };
742 assert(client
->opt
== NBD_OPT_STARTTLS
);
744 trace_nbd_negotiate_handle_starttls();
747 if (nbd_negotiate_send_rep(client
, NBD_REP_ACK
, errp
) < 0) {
751 tioc
= qio_channel_tls_new_server(ioc
,
759 qio_channel_set_name(QIO_CHANNEL(tioc
), "nbd-server-tls");
760 trace_nbd_negotiate_handle_starttls_handshake();
761 data
.loop
= g_main_loop_new(g_main_context_default(), FALSE
);
762 qio_channel_tls_handshake(tioc
,
768 if (!data
.complete
) {
769 g_main_loop_run(data
.loop
);
771 g_main_loop_unref(data
.loop
);
773 object_unref(OBJECT(tioc
));
774 error_propagate(errp
, data
.error
);
778 return QIO_CHANNEL(tioc
);
781 /* nbd_negotiate_send_meta_context
783 * Send one chunk of reply to NBD_OPT_{LIST,SET}_META_CONTEXT
785 * For NBD_OPT_LIST_META_CONTEXT @context_id is ignored, 0 is used instead.
787 static int nbd_negotiate_send_meta_context(NBDClient
*client
,
792 NBDOptionReplyMetaContext opt
;
793 struct iovec iov
[] = {
794 {.iov_base
= &opt
, .iov_len
= sizeof(opt
)},
795 {.iov_base
= (void *)context
, .iov_len
= strlen(context
)}
798 assert(iov
[1].iov_len
<= NBD_MAX_STRING_SIZE
);
799 if (client
->opt
== NBD_OPT_LIST_META_CONTEXT
) {
803 trace_nbd_negotiate_meta_query_reply(context
, context_id
);
804 set_be_option_rep(&opt
.h
, client
->opt
, NBD_REP_META_CONTEXT
,
805 sizeof(opt
) - sizeof(opt
.h
) + iov
[1].iov_len
);
806 stl_be_p(&opt
.context_id
, context_id
);
808 return qio_channel_writev_all(client
->ioc
, iov
, 2, errp
) < 0 ? -EIO
: 0;
812 * Return true if @query matches @pattern, or if @query is empty when
813 * the @client is performing _LIST_.
815 static bool nbd_meta_empty_or_pattern(NBDClient
*client
, const char *pattern
,
819 trace_nbd_negotiate_meta_query_parse("empty");
820 return client
->opt
== NBD_OPT_LIST_META_CONTEXT
;
822 if (strcmp(query
, pattern
) == 0) {
823 trace_nbd_negotiate_meta_query_parse(pattern
);
826 trace_nbd_negotiate_meta_query_skip("pattern not matched");
831 * Return true and adjust @str in place if it begins with @prefix.
833 static bool nbd_strshift(const char **str
, const char *prefix
)
835 size_t len
= strlen(prefix
);
837 if (strncmp(*str
, prefix
, len
) == 0) {
844 /* nbd_meta_base_query
846 * Handle queries to 'base' namespace. For now, only the base:allocation
847 * context is available. Return true if @query has been handled.
849 static bool nbd_meta_base_query(NBDClient
*client
, NBDExportMetaContexts
*meta
,
852 if (!nbd_strshift(&query
, "base:")) {
855 trace_nbd_negotiate_meta_query_parse("base:");
857 if (nbd_meta_empty_or_pattern(client
, "allocation", query
)) {
858 meta
->base_allocation
= true;
863 /* nbd_meta_qemu_query
865 * Handle queries to 'qemu' namespace. For now, only the qemu:dirty-bitmap:
866 * and qemu:allocation-depth contexts are available. Return true if @query
869 static bool nbd_meta_qemu_query(NBDClient
*client
, NBDExportMetaContexts
*meta
,
874 if (!nbd_strshift(&query
, "qemu:")) {
877 trace_nbd_negotiate_meta_query_parse("qemu:");
880 if (client
->opt
== NBD_OPT_LIST_META_CONTEXT
) {
881 meta
->allocation_depth
= meta
->exp
->allocation_depth
;
882 memset(meta
->bitmaps
, 1, meta
->exp
->nr_export_bitmaps
);
884 trace_nbd_negotiate_meta_query_parse("empty");
888 if (strcmp(query
, "allocation-depth") == 0) {
889 trace_nbd_negotiate_meta_query_parse("allocation-depth");
890 meta
->allocation_depth
= meta
->exp
->allocation_depth
;
894 if (nbd_strshift(&query
, "dirty-bitmap:")) {
895 trace_nbd_negotiate_meta_query_parse("dirty-bitmap:");
897 if (client
->opt
== NBD_OPT_LIST_META_CONTEXT
) {
898 memset(meta
->bitmaps
, 1, meta
->exp
->nr_export_bitmaps
);
900 trace_nbd_negotiate_meta_query_parse("empty");
904 for (i
= 0; i
< meta
->exp
->nr_export_bitmaps
; i
++) {
907 bm_name
= bdrv_dirty_bitmap_name(meta
->exp
->export_bitmaps
[i
]);
908 if (strcmp(bm_name
, query
) == 0) {
909 meta
->bitmaps
[i
] = true;
910 trace_nbd_negotiate_meta_query_parse(query
);
914 trace_nbd_negotiate_meta_query_skip("no dirty-bitmap match");
918 trace_nbd_negotiate_meta_query_skip("unknown qemu context");
922 /* nbd_negotiate_meta_query
924 * Parse namespace name and call corresponding function to parse body of the
927 * The only supported namespaces are 'base' and 'qemu'.
929 * Return -errno on I/O error, 0 if option was completely handled by
930 * sending a reply about inconsistent lengths, or 1 on success. */
931 static int nbd_negotiate_meta_query(NBDClient
*client
,
932 NBDExportMetaContexts
*meta
, Error
**errp
)
935 g_autofree
char *query
= NULL
;
938 ret
= nbd_opt_read(client
, &len
, sizeof(len
), false, errp
);
942 len
= cpu_to_be32(len
);
944 if (len
> NBD_MAX_STRING_SIZE
) {
945 trace_nbd_negotiate_meta_query_skip("length too long");
946 return nbd_opt_skip(client
, len
, errp
);
949 query
= g_malloc(len
+ 1);
950 ret
= nbd_opt_read(client
, query
, len
, true, errp
);
956 if (nbd_meta_base_query(client
, meta
, query
)) {
959 if (nbd_meta_qemu_query(client
, meta
, query
)) {
963 trace_nbd_negotiate_meta_query_skip("unknown namespace");
967 /* nbd_negotiate_meta_queries
968 * Handle NBD_OPT_LIST_META_CONTEXT and NBD_OPT_SET_META_CONTEXT
970 * Return -errno on I/O error, or 0 if option was completely handled. */
971 static int nbd_negotiate_meta_queries(NBDClient
*client
,
972 NBDExportMetaContexts
*meta
, Error
**errp
)
975 g_autofree
char *export_name
= NULL
;
976 /* Mark unused to work around https://bugs.llvm.org/show_bug.cgi?id=3888 */
977 g_autofree G_GNUC_UNUSED
bool *bitmaps
= NULL
;
978 NBDExportMetaContexts local_meta
= {0};
983 if (client
->opt
== NBD_OPT_SET_META_CONTEXT
&& !client
->structured_reply
) {
984 return nbd_opt_invalid(client
, errp
,
985 "request option '%s' when structured reply "
987 nbd_opt_lookup(client
->opt
));
990 if (client
->opt
== NBD_OPT_LIST_META_CONTEXT
) {
991 /* Only change the caller's meta on SET. */
995 g_free(meta
->bitmaps
);
996 memset(meta
, 0, sizeof(*meta
));
998 ret
= nbd_opt_read_name(client
, &export_name
, NULL
, errp
);
1003 meta
->exp
= nbd_export_find(export_name
);
1004 if (meta
->exp
== NULL
) {
1005 g_autofree
char *sane_name
= nbd_sanitize_name(export_name
);
1007 return nbd_opt_drop(client
, NBD_REP_ERR_UNKNOWN
, errp
,
1008 "export '%s' not present", sane_name
);
1010 meta
->bitmaps
= g_new0(bool, meta
->exp
->nr_export_bitmaps
);
1011 if (client
->opt
== NBD_OPT_LIST_META_CONTEXT
) {
1012 bitmaps
= meta
->bitmaps
;
1015 ret
= nbd_opt_read(client
, &nb_queries
, sizeof(nb_queries
), false, errp
);
1019 nb_queries
= cpu_to_be32(nb_queries
);
1020 trace_nbd_negotiate_meta_context(nbd_opt_lookup(client
->opt
),
1021 export_name
, nb_queries
);
1023 if (client
->opt
== NBD_OPT_LIST_META_CONTEXT
&& !nb_queries
) {
1024 /* enable all known contexts */
1025 meta
->base_allocation
= true;
1026 meta
->allocation_depth
= meta
->exp
->allocation_depth
;
1027 memset(meta
->bitmaps
, 1, meta
->exp
->nr_export_bitmaps
);
1029 for (i
= 0; i
< nb_queries
; ++i
) {
1030 ret
= nbd_negotiate_meta_query(client
, meta
, errp
);
1037 if (meta
->base_allocation
) {
1038 ret
= nbd_negotiate_send_meta_context(client
, "base:allocation",
1039 NBD_META_ID_BASE_ALLOCATION
,
1047 if (meta
->allocation_depth
) {
1048 ret
= nbd_negotiate_send_meta_context(client
, "qemu:allocation-depth",
1049 NBD_META_ID_ALLOCATION_DEPTH
,
1057 for (i
= 0; i
< meta
->exp
->nr_export_bitmaps
; i
++) {
1058 const char *bm_name
;
1059 g_autofree
char *context
= NULL
;
1061 if (!meta
->bitmaps
[i
]) {
1065 bm_name
= bdrv_dirty_bitmap_name(meta
->exp
->export_bitmaps
[i
]);
1066 context
= g_strdup_printf("qemu:dirty-bitmap:%s", bm_name
);
1068 ret
= nbd_negotiate_send_meta_context(client
, context
,
1069 NBD_META_ID_DIRTY_BITMAP
+ i
,
1077 ret
= nbd_negotiate_send_rep(client
, NBD_REP_ACK
, errp
);
1079 meta
->count
= count
;
1085 /* nbd_negotiate_options
1086 * Process all NBD_OPT_* client option commands, during fixed newstyle
1089 * -errno on error, errp is set
1090 * 0 on successful negotiation, errp is not set
1091 * 1 if client sent NBD_OPT_ABORT, i.e. on valid disconnect,
1094 static int nbd_negotiate_options(NBDClient
*client
, Error
**errp
)
1097 bool fixedNewstyle
= false;
1098 bool no_zeroes
= false;
1101 [ 0 .. 3] client flags
1103 Then we loop until NBD_OPT_EXPORT_NAME or NBD_OPT_GO:
1104 [ 0 .. 7] NBD_OPTS_MAGIC
1105 [ 8 .. 11] NBD option
1106 [12 .. 15] Data length
1109 [ 0 .. 7] NBD_OPTS_MAGIC
1110 [ 8 .. 11] Second NBD option
1111 [12 .. 15] Data length
1115 if (nbd_read32(client
->ioc
, &flags
, "flags", errp
) < 0) {
1118 trace_nbd_negotiate_options_flags(flags
);
1119 if (flags
& NBD_FLAG_C_FIXED_NEWSTYLE
) {
1120 fixedNewstyle
= true;
1121 flags
&= ~NBD_FLAG_C_FIXED_NEWSTYLE
;
1123 if (flags
& NBD_FLAG_C_NO_ZEROES
) {
1125 flags
&= ~NBD_FLAG_C_NO_ZEROES
;
1128 error_setg(errp
, "Unknown client flags 0x%" PRIx32
" received", flags
);
1134 uint32_t option
, length
;
1137 if (nbd_read64(client
->ioc
, &magic
, "opts magic", errp
) < 0) {
1140 trace_nbd_negotiate_options_check_magic(magic
);
1141 if (magic
!= NBD_OPTS_MAGIC
) {
1142 error_setg(errp
, "Bad magic received");
1146 if (nbd_read32(client
->ioc
, &option
, "option", errp
) < 0) {
1149 client
->opt
= option
;
1151 if (nbd_read32(client
->ioc
, &length
, "option length", errp
) < 0) {
1154 assert(!client
->optlen
);
1155 client
->optlen
= length
;
1157 if (length
> NBD_MAX_BUFFER_SIZE
) {
1158 error_setg(errp
, "len (%" PRIu32
" ) is larger than max len (%u)",
1159 length
, NBD_MAX_BUFFER_SIZE
);
1163 trace_nbd_negotiate_options_check_option(option
,
1164 nbd_opt_lookup(option
));
1165 if (client
->tlscreds
&&
1166 client
->ioc
== (QIOChannel
*)client
->sioc
) {
1168 if (!fixedNewstyle
) {
1169 error_setg(errp
, "Unsupported option 0x%" PRIx32
, option
);
1173 case NBD_OPT_STARTTLS
:
1175 /* Unconditionally drop the connection if the client
1176 * can't start a TLS negotiation correctly */
1177 return nbd_reject_length(client
, true, errp
);
1179 tioc
= nbd_negotiate_handle_starttls(client
, errp
);
1184 object_unref(OBJECT(client
->ioc
));
1185 client
->ioc
= QIO_CHANNEL(tioc
);
1188 case NBD_OPT_EXPORT_NAME
:
1189 /* No way to return an error to client, so drop connection */
1190 error_setg(errp
, "Option 0x%x not permitted before TLS",
1195 /* Let the client keep trying, unless they asked to
1196 * quit. Always try to give an error back to the
1197 * client; but when replying to OPT_ABORT, be aware
1198 * that the client may hang up before receiving the
1199 * error, in which case we are fine ignoring the
1200 * resulting EPIPE. */
1201 ret
= nbd_opt_drop(client
, NBD_REP_ERR_TLS_REQD
,
1202 option
== NBD_OPT_ABORT
? NULL
: errp
,
1204 " not permitted before TLS", option
);
1205 if (option
== NBD_OPT_ABORT
) {
1210 } else if (fixedNewstyle
) {
1214 ret
= nbd_reject_length(client
, false, errp
);
1216 ret
= nbd_negotiate_handle_list(client
, errp
);
1221 /* NBD spec says we must try to reply before
1222 * disconnecting, but that we must also tolerate
1223 * guests that don't wait for our reply. */
1224 nbd_negotiate_send_rep(client
, NBD_REP_ACK
, NULL
);
1227 case NBD_OPT_EXPORT_NAME
:
1228 return nbd_negotiate_handle_export_name(client
, no_zeroes
,
1233 ret
= nbd_negotiate_handle_info(client
, errp
);
1235 assert(option
== NBD_OPT_GO
);
1240 case NBD_OPT_STARTTLS
:
1242 ret
= nbd_reject_length(client
, false, errp
);
1243 } else if (client
->tlscreds
) {
1244 ret
= nbd_negotiate_send_rep_err(client
,
1245 NBD_REP_ERR_INVALID
, errp
,
1246 "TLS already enabled");
1248 ret
= nbd_negotiate_send_rep_err(client
,
1249 NBD_REP_ERR_POLICY
, errp
,
1250 "TLS not configured");
1254 case NBD_OPT_STRUCTURED_REPLY
:
1256 ret
= nbd_reject_length(client
, false, errp
);
1257 } else if (client
->structured_reply
) {
1258 ret
= nbd_negotiate_send_rep_err(
1259 client
, NBD_REP_ERR_INVALID
, errp
,
1260 "structured reply already negotiated");
1262 ret
= nbd_negotiate_send_rep(client
, NBD_REP_ACK
, errp
);
1263 client
->structured_reply
= true;
1267 case NBD_OPT_LIST_META_CONTEXT
:
1268 case NBD_OPT_SET_META_CONTEXT
:
1269 ret
= nbd_negotiate_meta_queries(client
, &client
->export_meta
,
1274 ret
= nbd_opt_drop(client
, NBD_REP_ERR_UNSUP
, errp
,
1275 "Unsupported option %" PRIu32
" (%s)",
1276 option
, nbd_opt_lookup(option
));
1281 * If broken new-style we should drop the connection
1282 * for anything except NBD_OPT_EXPORT_NAME
1285 case NBD_OPT_EXPORT_NAME
:
1286 return nbd_negotiate_handle_export_name(client
, no_zeroes
,
1290 error_setg(errp
, "Unsupported option %" PRIu32
" (%s)",
1291 option
, nbd_opt_lookup(option
));
1303 * -errno on error, errp is set
1304 * 0 on successful negotiation, errp is not set
1305 * 1 if client sent NBD_OPT_ABORT, i.e. on valid disconnect,
1308 static coroutine_fn
int nbd_negotiate(NBDClient
*client
, Error
**errp
)
1311 char buf
[NBD_OLDSTYLE_NEGOTIATE_SIZE
] = "";
1314 /* Old style negotiation header, no room for options
1315 [ 0 .. 7] passwd ("NBDMAGIC")
1316 [ 8 .. 15] magic (NBD_CLIENT_MAGIC)
1318 [24 .. 27] export flags (zero-extended)
1319 [28 .. 151] reserved (0)
1321 New style negotiation header, client can send options
1322 [ 0 .. 7] passwd ("NBDMAGIC")
1323 [ 8 .. 15] magic (NBD_OPTS_MAGIC)
1324 [16 .. 17] server flags (0)
1325 ....options sent, ending in NBD_OPT_EXPORT_NAME or NBD_OPT_GO....
1328 qio_channel_set_blocking(client
->ioc
, false, NULL
);
1330 trace_nbd_negotiate_begin();
1331 memcpy(buf
, "NBDMAGIC", 8);
1333 stq_be_p(buf
+ 8, NBD_OPTS_MAGIC
);
1334 stw_be_p(buf
+ 16, NBD_FLAG_FIXED_NEWSTYLE
| NBD_FLAG_NO_ZEROES
);
1336 if (nbd_write(client
->ioc
, buf
, 18, errp
) < 0) {
1337 error_prepend(errp
, "write failed: ");
1340 ret
= nbd_negotiate_options(client
, errp
);
1343 error_prepend(errp
, "option negotiation failed: ");
1348 /* Attach the channel to the same AioContext as the export */
1349 if (client
->exp
&& client
->exp
->common
.ctx
) {
1350 qio_channel_attach_aio_context(client
->ioc
, client
->exp
->common
.ctx
);
1353 assert(!client
->optlen
);
1354 trace_nbd_negotiate_success();
1360 * Tries to read @size bytes from @ioc. This is a local implementation of
1361 * qio_channel_readv_all_eof. We have it here because we need it to be
1362 * interruptible and to know when the coroutine is yielding.
1363 * Returns 1 on success
1364 * 0 on eof, when no data was read (errp is not set)
1365 * negative errno on failure (errp is set)
1367 static inline int coroutine_fn
1368 nbd_read_eof(NBDClient
*client
, void *buffer
, size_t size
, Error
**errp
)
1370 bool partial
= false;
1374 struct iovec iov
= { .iov_base
= buffer
, .iov_len
= size
};
1377 len
= qio_channel_readv(client
->ioc
, &iov
, 1, errp
);
1378 if (len
== QIO_CHANNEL_ERR_BLOCK
) {
1379 client
->read_yielding
= true;
1380 qio_channel_yield(client
->ioc
, G_IO_IN
);
1381 client
->read_yielding
= false;
1382 if (client
->quiescing
) {
1386 } else if (len
< 0) {
1388 } else if (len
== 0) {
1391 "Unexpected end-of-file before all bytes were read");
1400 buffer
= (uint8_t *) buffer
+ len
;
1405 static int nbd_receive_request(NBDClient
*client
, NBDRequest
*request
,
1408 uint8_t buf
[NBD_REQUEST_SIZE
];
1412 ret
= nbd_read_eof(client
, buf
, sizeof(buf
), errp
);
1418 [ 0 .. 3] magic (NBD_REQUEST_MAGIC)
1419 [ 4 .. 5] flags (NBD_CMD_FLAG_FUA, ...)
1420 [ 6 .. 7] type (NBD_CMD_READ, ...)
1426 magic
= ldl_be_p(buf
);
1427 request
->flags
= lduw_be_p(buf
+ 4);
1428 request
->type
= lduw_be_p(buf
+ 6);
1429 request
->handle
= ldq_be_p(buf
+ 8);
1430 request
->from
= ldq_be_p(buf
+ 16);
1431 request
->len
= ldl_be_p(buf
+ 24);
1433 trace_nbd_receive_request(magic
, request
->flags
, request
->type
,
1434 request
->from
, request
->len
);
1436 if (magic
!= NBD_REQUEST_MAGIC
) {
1437 error_setg(errp
, "invalid magic (got 0x%" PRIx32
")", magic
);
1443 #define MAX_NBD_REQUESTS 16
1445 void nbd_client_get(NBDClient
*client
)
1450 void nbd_client_put(NBDClient
*client
)
1452 if (--client
->refcount
== 0) {
1453 /* The last reference should be dropped by client->close,
1454 * which is called by client_close.
1456 assert(client
->closing
);
1458 qio_channel_detach_aio_context(client
->ioc
);
1459 object_unref(OBJECT(client
->sioc
));
1460 object_unref(OBJECT(client
->ioc
));
1461 if (client
->tlscreds
) {
1462 object_unref(OBJECT(client
->tlscreds
));
1464 g_free(client
->tlsauthz
);
1466 QTAILQ_REMOVE(&client
->exp
->clients
, client
, next
);
1467 blk_exp_unref(&client
->exp
->common
);
1469 g_free(client
->export_meta
.bitmaps
);
1474 static void client_close(NBDClient
*client
, bool negotiated
)
1476 if (client
->closing
) {
1480 client
->closing
= true;
1482 /* Force requests to finish. They will drop their own references,
1483 * then we'll close the socket and free the NBDClient.
1485 qio_channel_shutdown(client
->ioc
, QIO_CHANNEL_SHUTDOWN_BOTH
,
1488 /* Also tell the client, so that they release their reference. */
1489 if (client
->close_fn
) {
1490 client
->close_fn(client
, negotiated
);
1494 static NBDRequestData
*nbd_request_get(NBDClient
*client
)
1496 NBDRequestData
*req
;
1498 assert(client
->nb_requests
<= MAX_NBD_REQUESTS
- 1);
1499 client
->nb_requests
++;
1501 req
= g_new0(NBDRequestData
, 1);
1502 nbd_client_get(client
);
1503 req
->client
= client
;
1507 static void nbd_request_put(NBDRequestData
*req
)
1509 NBDClient
*client
= req
->client
;
1512 qemu_vfree(req
->data
);
1516 client
->nb_requests
--;
1518 if (client
->quiescing
&& client
->nb_requests
== 0) {
1522 nbd_client_receive_next_request(client
);
1524 nbd_client_put(client
);
1527 static void blk_aio_attached(AioContext
*ctx
, void *opaque
)
1529 NBDExport
*exp
= opaque
;
1532 trace_nbd_blk_aio_attached(exp
->name
, ctx
);
1534 exp
->common
.ctx
= ctx
;
1536 QTAILQ_FOREACH(client
, &exp
->clients
, next
) {
1537 qio_channel_attach_aio_context(client
->ioc
, ctx
);
1539 assert(client
->nb_requests
== 0);
1540 assert(client
->recv_coroutine
== NULL
);
1541 assert(client
->send_coroutine
== NULL
);
1545 static void blk_aio_detach(void *opaque
)
1547 NBDExport
*exp
= opaque
;
1550 trace_nbd_blk_aio_detach(exp
->name
, exp
->common
.ctx
);
1552 QTAILQ_FOREACH(client
, &exp
->clients
, next
) {
1553 qio_channel_detach_aio_context(client
->ioc
);
1556 exp
->common
.ctx
= NULL
;
1559 static void nbd_drained_begin(void *opaque
)
1561 NBDExport
*exp
= opaque
;
1564 QTAILQ_FOREACH(client
, &exp
->clients
, next
) {
1565 client
->quiescing
= true;
1569 static void nbd_drained_end(void *opaque
)
1571 NBDExport
*exp
= opaque
;
1574 QTAILQ_FOREACH(client
, &exp
->clients
, next
) {
1575 client
->quiescing
= false;
1576 nbd_client_receive_next_request(client
);
1580 static bool nbd_drained_poll(void *opaque
)
1582 NBDExport
*exp
= opaque
;
1585 QTAILQ_FOREACH(client
, &exp
->clients
, next
) {
1586 if (client
->nb_requests
!= 0) {
1588 * If there's a coroutine waiting for a request on nbd_read_eof()
1589 * enter it here so we don't depend on the client to wake it up.
1591 if (client
->recv_coroutine
!= NULL
&& client
->read_yielding
) {
1592 qemu_aio_coroutine_enter(exp
->common
.ctx
,
1593 client
->recv_coroutine
);
1603 static void nbd_eject_notifier(Notifier
*n
, void *data
)
1605 NBDExport
*exp
= container_of(n
, NBDExport
, eject_notifier
);
1607 blk_exp_request_shutdown(&exp
->common
);
1610 void nbd_export_set_on_eject_blk(BlockExport
*exp
, BlockBackend
*blk
)
1612 NBDExport
*nbd_exp
= container_of(exp
, NBDExport
, common
);
1613 assert(exp
->drv
== &blk_exp_nbd
);
1614 assert(nbd_exp
->eject_notifier_blk
== NULL
);
1617 nbd_exp
->eject_notifier_blk
= blk
;
1618 nbd_exp
->eject_notifier
.notify
= nbd_eject_notifier
;
1619 blk_add_remove_bs_notifier(blk
, &nbd_exp
->eject_notifier
);
1622 static const BlockDevOps nbd_block_ops
= {
1623 .drained_begin
= nbd_drained_begin
,
1624 .drained_end
= nbd_drained_end
,
1625 .drained_poll
= nbd_drained_poll
,
1628 static int nbd_export_create(BlockExport
*blk_exp
, BlockExportOptions
*exp_args
,
1631 NBDExport
*exp
= container_of(blk_exp
, NBDExport
, common
);
1632 BlockExportOptionsNbd
*arg
= &exp_args
->u
.nbd
;
1633 BlockBackend
*blk
= blk_exp
->blk
;
1635 uint64_t perm
, shared_perm
;
1636 bool readonly
= !exp_args
->writable
;
1637 bool shared
= !exp_args
->writable
;
1642 assert(exp_args
->type
== BLOCK_EXPORT_TYPE_NBD
);
1644 if (!nbd_server_is_running()) {
1645 error_setg(errp
, "NBD server not running");
1649 if (!arg
->has_name
) {
1650 arg
->name
= exp_args
->node_name
;
1653 if (strlen(arg
->name
) > NBD_MAX_STRING_SIZE
) {
1654 error_setg(errp
, "export name '%s' too long", arg
->name
);
1658 if (arg
->description
&& strlen(arg
->description
) > NBD_MAX_STRING_SIZE
) {
1659 error_setg(errp
, "description '%s' too long", arg
->description
);
1663 if (nbd_export_find(arg
->name
)) {
1664 error_setg(errp
, "NBD server already has export named '%s'", arg
->name
);
1668 size
= blk_getlength(blk
);
1670 error_setg_errno(errp
, -size
,
1671 "Failed to determine the NBD export's length");
1675 /* Don't allow resize while the NBD server is running, otherwise we don't
1676 * care what happens with the node. */
1677 blk_get_perm(blk
, &perm
, &shared_perm
);
1678 ret
= blk_set_perm(blk
, perm
, shared_perm
& ~BLK_PERM_RESIZE
, errp
);
1683 QTAILQ_INIT(&exp
->clients
);
1684 exp
->name
= g_strdup(arg
->name
);
1685 exp
->description
= g_strdup(arg
->description
);
1686 exp
->nbdflags
= (NBD_FLAG_HAS_FLAGS
| NBD_FLAG_SEND_FLUSH
|
1687 NBD_FLAG_SEND_FUA
| NBD_FLAG_SEND_CACHE
);
1689 exp
->nbdflags
|= NBD_FLAG_READ_ONLY
;
1691 exp
->nbdflags
|= NBD_FLAG_CAN_MULTI_CONN
;
1694 exp
->nbdflags
|= (NBD_FLAG_SEND_TRIM
| NBD_FLAG_SEND_WRITE_ZEROES
|
1695 NBD_FLAG_SEND_FAST_ZERO
);
1697 exp
->size
= QEMU_ALIGN_DOWN(size
, BDRV_SECTOR_SIZE
);
1699 for (bitmaps
= arg
->bitmaps
; bitmaps
; bitmaps
= bitmaps
->next
) {
1700 exp
->nr_export_bitmaps
++;
1702 exp
->export_bitmaps
= g_new0(BdrvDirtyBitmap
*, exp
->nr_export_bitmaps
);
1703 for (i
= 0, bitmaps
= arg
->bitmaps
; bitmaps
;
1704 i
++, bitmaps
= bitmaps
->next
) {
1705 const char *bitmap
= bitmaps
->value
;
1706 BlockDriverState
*bs
= blk_bs(blk
);
1707 BdrvDirtyBitmap
*bm
= NULL
;
1710 bm
= bdrv_find_dirty_bitmap(bs
, bitmap
);
1715 bs
= bdrv_filter_or_cow_bs(bs
);
1720 error_setg(errp
, "Bitmap '%s' is not found", bitmap
);
1724 if (bdrv_dirty_bitmap_check(bm
, BDRV_BITMAP_ALLOW_RO
, errp
)) {
1729 if (readonly
&& bdrv_is_writable(bs
) &&
1730 bdrv_dirty_bitmap_enabled(bm
)) {
1733 "Enabled bitmap '%s' incompatible with readonly export",
1738 exp
->export_bitmaps
[i
] = bm
;
1739 assert(strlen(bitmap
) <= BDRV_BITMAP_MAX_NAME_SIZE
);
1742 /* Mark bitmaps busy in a separate loop, to simplify roll-back concerns. */
1743 for (i
= 0; i
< exp
->nr_export_bitmaps
; i
++) {
1744 bdrv_dirty_bitmap_set_busy(exp
->export_bitmaps
[i
], true);
1747 exp
->allocation_depth
= arg
->allocation_depth
;
1750 * We need to inhibit request queuing in the block layer to ensure we can
1751 * be properly quiesced when entering a drained section, as our coroutines
1752 * servicing pending requests might enter blk_pread().
1754 blk_set_disable_request_queuing(blk
, true);
1756 blk_add_aio_context_notifier(blk
, blk_aio_attached
, blk_aio_detach
, exp
);
1758 blk_set_dev_ops(blk
, &nbd_block_ops
, exp
);
1760 QTAILQ_INSERT_TAIL(&exports
, exp
, next
);
1765 g_free(exp
->export_bitmaps
);
1767 g_free(exp
->description
);
1771 NBDExport
*nbd_export_find(const char *name
)
1774 QTAILQ_FOREACH(exp
, &exports
, next
) {
1775 if (strcmp(name
, exp
->name
) == 0) {
1784 nbd_export_aio_context(NBDExport
*exp
)
1786 return exp
->common
.ctx
;
1789 static void nbd_export_request_shutdown(BlockExport
*blk_exp
)
1791 NBDExport
*exp
= container_of(blk_exp
, NBDExport
, common
);
1792 NBDClient
*client
, *next
;
1794 blk_exp_ref(&exp
->common
);
1796 * TODO: Should we expand QMP NbdServerRemoveNode enum to allow a
1797 * close mode that stops advertising the export to new clients but
1798 * still permits existing clients to run to completion? Because of
1799 * that possibility, nbd_export_close() can be called more than
1800 * once on an export.
1802 QTAILQ_FOREACH_SAFE(client
, &exp
->clients
, next
, next
) {
1803 client_close(client
, true);
1808 QTAILQ_REMOVE(&exports
, exp
, next
);
1810 blk_exp_unref(&exp
->common
);
1813 static void nbd_export_delete(BlockExport
*blk_exp
)
1816 NBDExport
*exp
= container_of(blk_exp
, NBDExport
, common
);
1818 assert(exp
->name
== NULL
);
1819 assert(QTAILQ_EMPTY(&exp
->clients
));
1821 g_free(exp
->description
);
1822 exp
->description
= NULL
;
1824 if (exp
->common
.blk
) {
1825 if (exp
->eject_notifier_blk
) {
1826 notifier_remove(&exp
->eject_notifier
);
1827 blk_unref(exp
->eject_notifier_blk
);
1829 blk_remove_aio_context_notifier(exp
->common
.blk
, blk_aio_attached
,
1830 blk_aio_detach
, exp
);
1831 blk_set_disable_request_queuing(exp
->common
.blk
, false);
1834 for (i
= 0; i
< exp
->nr_export_bitmaps
; i
++) {
1835 bdrv_dirty_bitmap_set_busy(exp
->export_bitmaps
[i
], false);
1839 const BlockExportDriver blk_exp_nbd
= {
1840 .type
= BLOCK_EXPORT_TYPE_NBD
,
1841 .instance_size
= sizeof(NBDExport
),
1842 .create
= nbd_export_create
,
1843 .delete = nbd_export_delete
,
1844 .request_shutdown
= nbd_export_request_shutdown
,
1847 static int coroutine_fn
nbd_co_send_iov(NBDClient
*client
, struct iovec
*iov
,
1848 unsigned niov
, Error
**errp
)
1852 g_assert(qemu_in_coroutine());
1853 qemu_co_mutex_lock(&client
->send_lock
);
1854 client
->send_coroutine
= qemu_coroutine_self();
1856 ret
= qio_channel_writev_all(client
->ioc
, iov
, niov
, errp
) < 0 ? -EIO
: 0;
1858 client
->send_coroutine
= NULL
;
1859 qemu_co_mutex_unlock(&client
->send_lock
);
1864 static inline void set_be_simple_reply(NBDSimpleReply
*reply
, uint64_t error
,
1867 stl_be_p(&reply
->magic
, NBD_SIMPLE_REPLY_MAGIC
);
1868 stl_be_p(&reply
->error
, error
);
1869 stq_be_p(&reply
->handle
, handle
);
1872 static int nbd_co_send_simple_reply(NBDClient
*client
,
1879 NBDSimpleReply reply
;
1880 int nbd_err
= system_errno_to_nbd_errno(error
);
1881 struct iovec iov
[] = {
1882 {.iov_base
= &reply
, .iov_len
= sizeof(reply
)},
1883 {.iov_base
= data
, .iov_len
= len
}
1886 trace_nbd_co_send_simple_reply(handle
, nbd_err
, nbd_err_lookup(nbd_err
),
1888 set_be_simple_reply(&reply
, nbd_err
, handle
);
1890 return nbd_co_send_iov(client
, iov
, len
? 2 : 1, errp
);
1893 static inline void set_be_chunk(NBDStructuredReplyChunk
*chunk
, uint16_t flags
,
1894 uint16_t type
, uint64_t handle
, uint32_t length
)
1896 stl_be_p(&chunk
->magic
, NBD_STRUCTURED_REPLY_MAGIC
);
1897 stw_be_p(&chunk
->flags
, flags
);
1898 stw_be_p(&chunk
->type
, type
);
1899 stq_be_p(&chunk
->handle
, handle
);
1900 stl_be_p(&chunk
->length
, length
);
1903 static int coroutine_fn
nbd_co_send_structured_done(NBDClient
*client
,
1907 NBDStructuredReplyChunk chunk
;
1908 struct iovec iov
[] = {
1909 {.iov_base
= &chunk
, .iov_len
= sizeof(chunk
)},
1912 trace_nbd_co_send_structured_done(handle
);
1913 set_be_chunk(&chunk
, NBD_REPLY_FLAG_DONE
, NBD_REPLY_TYPE_NONE
, handle
, 0);
1915 return nbd_co_send_iov(client
, iov
, 1, errp
);
1918 static int coroutine_fn
nbd_co_send_structured_read(NBDClient
*client
,
1926 NBDStructuredReadData chunk
;
1927 struct iovec iov
[] = {
1928 {.iov_base
= &chunk
, .iov_len
= sizeof(chunk
)},
1929 {.iov_base
= data
, .iov_len
= size
}
1933 trace_nbd_co_send_structured_read(handle
, offset
, data
, size
);
1934 set_be_chunk(&chunk
.h
, final
? NBD_REPLY_FLAG_DONE
: 0,
1935 NBD_REPLY_TYPE_OFFSET_DATA
, handle
,
1936 sizeof(chunk
) - sizeof(chunk
.h
) + size
);
1937 stq_be_p(&chunk
.offset
, offset
);
1939 return nbd_co_send_iov(client
, iov
, 2, errp
);
1942 static int coroutine_fn
nbd_co_send_structured_error(NBDClient
*client
,
1948 NBDStructuredError chunk
;
1949 int nbd_err
= system_errno_to_nbd_errno(error
);
1950 struct iovec iov
[] = {
1951 {.iov_base
= &chunk
, .iov_len
= sizeof(chunk
)},
1952 {.iov_base
= (char *)msg
, .iov_len
= msg
? strlen(msg
) : 0},
1956 trace_nbd_co_send_structured_error(handle
, nbd_err
,
1957 nbd_err_lookup(nbd_err
), msg
? msg
: "");
1958 set_be_chunk(&chunk
.h
, NBD_REPLY_FLAG_DONE
, NBD_REPLY_TYPE_ERROR
, handle
,
1959 sizeof(chunk
) - sizeof(chunk
.h
) + iov
[1].iov_len
);
1960 stl_be_p(&chunk
.error
, nbd_err
);
1961 stw_be_p(&chunk
.message_length
, iov
[1].iov_len
);
1963 return nbd_co_send_iov(client
, iov
, 1 + !!iov
[1].iov_len
, errp
);
1966 /* Do a sparse read and send the structured reply to the client.
1967 * Returns -errno if sending fails. bdrv_block_status_above() failure is
1968 * reported to the client, at which point this function succeeds.
1970 static int coroutine_fn
nbd_co_send_sparse_read(NBDClient
*client
,
1978 NBDExport
*exp
= client
->exp
;
1979 size_t progress
= 0;
1981 while (progress
< size
) {
1983 int status
= bdrv_block_status_above(blk_bs(exp
->common
.blk
), NULL
,
1985 size
- progress
, &pnum
, NULL
,
1990 char *msg
= g_strdup_printf("unable to check for holes: %s",
1993 ret
= nbd_co_send_structured_error(client
, handle
, -status
, msg
,
1998 assert(pnum
&& pnum
<= size
- progress
);
1999 final
= progress
+ pnum
== size
;
2000 if (status
& BDRV_BLOCK_ZERO
) {
2001 NBDStructuredReadHole chunk
;
2002 struct iovec iov
[] = {
2003 {.iov_base
= &chunk
, .iov_len
= sizeof(chunk
)},
2006 trace_nbd_co_send_structured_read_hole(handle
, offset
+ progress
,
2008 set_be_chunk(&chunk
.h
, final
? NBD_REPLY_FLAG_DONE
: 0,
2009 NBD_REPLY_TYPE_OFFSET_HOLE
,
2010 handle
, sizeof(chunk
) - sizeof(chunk
.h
));
2011 stq_be_p(&chunk
.offset
, offset
+ progress
);
2012 stl_be_p(&chunk
.length
, pnum
);
2013 ret
= nbd_co_send_iov(client
, iov
, 1, errp
);
2015 ret
= blk_pread(exp
->common
.blk
, offset
+ progress
,
2016 data
+ progress
, pnum
);
2018 error_setg_errno(errp
, -ret
, "reading from file failed");
2021 ret
= nbd_co_send_structured_read(client
, handle
, offset
+ progress
,
2022 data
+ progress
, pnum
, final
,
2034 typedef struct NBDExtentArray
{
2036 unsigned int nb_alloc
;
2038 uint64_t total_length
;
2040 bool converted_to_be
;
2043 static NBDExtentArray
*nbd_extent_array_new(unsigned int nb_alloc
)
2045 NBDExtentArray
*ea
= g_new0(NBDExtentArray
, 1);
2047 ea
->nb_alloc
= nb_alloc
;
2048 ea
->extents
= g_new(NBDExtent
, nb_alloc
);
2054 static void nbd_extent_array_free(NBDExtentArray
*ea
)
2056 g_free(ea
->extents
);
2059 G_DEFINE_AUTOPTR_CLEANUP_FUNC(NBDExtentArray
, nbd_extent_array_free
);
2061 /* Further modifications of the array after conversion are abandoned */
2062 static void nbd_extent_array_convert_to_be(NBDExtentArray
*ea
)
2066 assert(!ea
->converted_to_be
);
2067 ea
->can_add
= false;
2068 ea
->converted_to_be
= true;
2070 for (i
= 0; i
< ea
->count
; i
++) {
2071 ea
->extents
[i
].flags
= cpu_to_be32(ea
->extents
[i
].flags
);
2072 ea
->extents
[i
].length
= cpu_to_be32(ea
->extents
[i
].length
);
2077 * Add extent to NBDExtentArray. If extent can't be added (no available space),
2079 * For safety, when returning -1 for the first time, .can_add is set to false,
2080 * further call to nbd_extent_array_add() will crash.
2081 * (to avoid the situation, when after failing to add an extent (returned -1),
2082 * user miss this failure and add another extent, which is successfully added
2083 * (array is full, but new extent may be squashed into the last one), then we
2084 * have invalid array with skipped extent)
2086 static int nbd_extent_array_add(NBDExtentArray
*ea
,
2087 uint32_t length
, uint32_t flags
)
2089 assert(ea
->can_add
);
2095 /* Extend previous extent if flags are the same */
2096 if (ea
->count
> 0 && flags
== ea
->extents
[ea
->count
- 1].flags
) {
2097 uint64_t sum
= (uint64_t)length
+ ea
->extents
[ea
->count
- 1].length
;
2099 if (sum
<= UINT32_MAX
) {
2100 ea
->extents
[ea
->count
- 1].length
= sum
;
2101 ea
->total_length
+= length
;
2106 if (ea
->count
>= ea
->nb_alloc
) {
2107 ea
->can_add
= false;
2111 ea
->total_length
+= length
;
2112 ea
->extents
[ea
->count
] = (NBDExtent
) {.length
= length
, .flags
= flags
};
2118 static int blockstatus_to_extents(BlockDriverState
*bs
, uint64_t offset
,
2119 uint64_t bytes
, NBDExtentArray
*ea
)
2124 int ret
= bdrv_block_status_above(bs
, NULL
, offset
, bytes
, &num
,
2131 flags
= (ret
& BDRV_BLOCK_DATA
? 0 : NBD_STATE_HOLE
) |
2132 (ret
& BDRV_BLOCK_ZERO
? NBD_STATE_ZERO
: 0);
2134 if (nbd_extent_array_add(ea
, num
, flags
) < 0) {
2145 static int blockalloc_to_extents(BlockDriverState
*bs
, uint64_t offset
,
2146 uint64_t bytes
, NBDExtentArray
*ea
)
2150 int ret
= bdrv_is_allocated_above(bs
, NULL
, false, offset
, bytes
,
2157 if (nbd_extent_array_add(ea
, num
, ret
) < 0) {
2169 * nbd_co_send_extents
2171 * @ea is converted to BE by the function
2172 * @last controls whether NBD_REPLY_FLAG_DONE is sent.
2174 static int nbd_co_send_extents(NBDClient
*client
, uint64_t handle
,
2176 bool last
, uint32_t context_id
, Error
**errp
)
2178 NBDStructuredMeta chunk
;
2179 struct iovec iov
[] = {
2180 {.iov_base
= &chunk
, .iov_len
= sizeof(chunk
)},
2181 {.iov_base
= ea
->extents
, .iov_len
= ea
->count
* sizeof(ea
->extents
[0])}
2184 nbd_extent_array_convert_to_be(ea
);
2186 trace_nbd_co_send_extents(handle
, ea
->count
, context_id
, ea
->total_length
,
2188 set_be_chunk(&chunk
.h
, last
? NBD_REPLY_FLAG_DONE
: 0,
2189 NBD_REPLY_TYPE_BLOCK_STATUS
,
2190 handle
, sizeof(chunk
) - sizeof(chunk
.h
) + iov
[1].iov_len
);
2191 stl_be_p(&chunk
.context_id
, context_id
);
2193 return nbd_co_send_iov(client
, iov
, 2, errp
);
2196 /* Get block status from the exported device and send it to the client */
2197 static int nbd_co_send_block_status(NBDClient
*client
, uint64_t handle
,
2198 BlockDriverState
*bs
, uint64_t offset
,
2199 uint32_t length
, bool dont_fragment
,
2200 bool last
, uint32_t context_id
,
2204 unsigned int nb_extents
= dont_fragment
? 1 : NBD_MAX_BLOCK_STATUS_EXTENTS
;
2205 g_autoptr(NBDExtentArray
) ea
= nbd_extent_array_new(nb_extents
);
2207 if (context_id
== NBD_META_ID_BASE_ALLOCATION
) {
2208 ret
= blockstatus_to_extents(bs
, offset
, length
, ea
);
2210 ret
= blockalloc_to_extents(bs
, offset
, length
, ea
);
2213 return nbd_co_send_structured_error(
2214 client
, handle
, -ret
, "can't get block status", errp
);
2217 return nbd_co_send_extents(client
, handle
, ea
, last
, context_id
, errp
);
2220 /* Populate @ea from a dirty bitmap. */
2221 static void bitmap_to_extents(BdrvDirtyBitmap
*bitmap
,
2222 uint64_t offset
, uint64_t length
,
2225 int64_t start
, dirty_start
, dirty_count
;
2226 int64_t end
= offset
+ length
;
2229 bdrv_dirty_bitmap_lock(bitmap
);
2231 for (start
= offset
;
2232 bdrv_dirty_bitmap_next_dirty_area(bitmap
, start
, end
, INT32_MAX
,
2233 &dirty_start
, &dirty_count
);
2234 start
= dirty_start
+ dirty_count
)
2236 if ((nbd_extent_array_add(es
, dirty_start
- start
, 0) < 0) ||
2237 (nbd_extent_array_add(es
, dirty_count
, NBD_STATE_DIRTY
) < 0))
2245 /* last non dirty extent, nothing to do if array is now full */
2246 (void) nbd_extent_array_add(es
, end
- start
, 0);
2249 bdrv_dirty_bitmap_unlock(bitmap
);
2252 static int nbd_co_send_bitmap(NBDClient
*client
, uint64_t handle
,
2253 BdrvDirtyBitmap
*bitmap
, uint64_t offset
,
2254 uint32_t length
, bool dont_fragment
, bool last
,
2255 uint32_t context_id
, Error
**errp
)
2257 unsigned int nb_extents
= dont_fragment
? 1 : NBD_MAX_BLOCK_STATUS_EXTENTS
;
2258 g_autoptr(NBDExtentArray
) ea
= nbd_extent_array_new(nb_extents
);
2260 bitmap_to_extents(bitmap
, offset
, length
, ea
);
2262 return nbd_co_send_extents(client
, handle
, ea
, last
, context_id
, errp
);
2265 /* nbd_co_receive_request
2266 * Collect a client request. Return 0 if request looks valid, -EIO to drop
2267 * connection right away, -EAGAIN to indicate we were interrupted and the
2268 * channel should be quiesced, and any other negative value to report an error
2269 * to the client (although the caller may still need to disconnect after
2270 * reporting the error).
2272 static int nbd_co_receive_request(NBDRequestData
*req
, NBDRequest
*request
,
2275 NBDClient
*client
= req
->client
;
2279 g_assert(qemu_in_coroutine());
2280 assert(client
->recv_coroutine
== qemu_coroutine_self());
2281 ret
= nbd_receive_request(client
, request
, errp
);
2286 trace_nbd_co_receive_request_decode_type(request
->handle
, request
->type
,
2287 nbd_cmd_lookup(request
->type
));
2289 if (request
->type
!= NBD_CMD_WRITE
) {
2290 /* No payload, we are ready to read the next request. */
2291 req
->complete
= true;
2294 if (request
->type
== NBD_CMD_DISC
) {
2295 /* Special case: we're going to disconnect without a reply,
2296 * whether or not flags, from, or len are bogus */
2300 if (request
->type
== NBD_CMD_READ
|| request
->type
== NBD_CMD_WRITE
||
2301 request
->type
== NBD_CMD_CACHE
)
2303 if (request
->len
> NBD_MAX_BUFFER_SIZE
) {
2304 error_setg(errp
, "len (%" PRIu32
" ) is larger than max len (%u)",
2305 request
->len
, NBD_MAX_BUFFER_SIZE
);
2309 if (request
->type
!= NBD_CMD_CACHE
) {
2310 req
->data
= blk_try_blockalign(client
->exp
->common
.blk
,
2312 if (req
->data
== NULL
) {
2313 error_setg(errp
, "No memory");
2319 if (request
->type
== NBD_CMD_WRITE
) {
2320 if (nbd_read(client
->ioc
, req
->data
, request
->len
, "CMD_WRITE data",
2325 req
->complete
= true;
2327 trace_nbd_co_receive_request_payload_received(request
->handle
,
2331 /* Sanity checks. */
2332 if (client
->exp
->nbdflags
& NBD_FLAG_READ_ONLY
&&
2333 (request
->type
== NBD_CMD_WRITE
||
2334 request
->type
== NBD_CMD_WRITE_ZEROES
||
2335 request
->type
== NBD_CMD_TRIM
)) {
2336 error_setg(errp
, "Export is read-only");
2339 if (request
->from
> client
->exp
->size
||
2340 request
->len
> client
->exp
->size
- request
->from
) {
2341 error_setg(errp
, "operation past EOF; From: %" PRIu64
", Len: %" PRIu32
2342 ", Size: %" PRIu64
, request
->from
, request
->len
,
2344 return (request
->type
== NBD_CMD_WRITE
||
2345 request
->type
== NBD_CMD_WRITE_ZEROES
) ? -ENOSPC
: -EINVAL
;
2347 if (client
->check_align
&& !QEMU_IS_ALIGNED(request
->from
| request
->len
,
2348 client
->check_align
)) {
2350 * The block layer gracefully handles unaligned requests, but
2351 * it's still worth tracing client non-compliance
2353 trace_nbd_co_receive_align_compliance(nbd_cmd_lookup(request
->type
),
2356 client
->check_align
);
2358 valid_flags
= NBD_CMD_FLAG_FUA
;
2359 if (request
->type
== NBD_CMD_READ
&& client
->structured_reply
) {
2360 valid_flags
|= NBD_CMD_FLAG_DF
;
2361 } else if (request
->type
== NBD_CMD_WRITE_ZEROES
) {
2362 valid_flags
|= NBD_CMD_FLAG_NO_HOLE
| NBD_CMD_FLAG_FAST_ZERO
;
2363 } else if (request
->type
== NBD_CMD_BLOCK_STATUS
) {
2364 valid_flags
|= NBD_CMD_FLAG_REQ_ONE
;
2366 if (request
->flags
& ~valid_flags
) {
2367 error_setg(errp
, "unsupported flags for command %s (got 0x%x)",
2368 nbd_cmd_lookup(request
->type
), request
->flags
);
2375 /* Send simple reply without a payload, or a structured error
2376 * @error_msg is ignored if @ret >= 0
2377 * Returns 0 if connection is still live, -errno on failure to talk to client
2379 static coroutine_fn
int nbd_send_generic_reply(NBDClient
*client
,
2382 const char *error_msg
,
2385 if (client
->structured_reply
&& ret
< 0) {
2386 return nbd_co_send_structured_error(client
, handle
, -ret
, error_msg
,
2389 return nbd_co_send_simple_reply(client
, handle
, ret
< 0 ? -ret
: 0,
2394 /* Handle NBD_CMD_READ request.
2395 * Return -errno if sending fails. Other errors are reported directly to the
2396 * client as an error reply. */
2397 static coroutine_fn
int nbd_do_cmd_read(NBDClient
*client
, NBDRequest
*request
,
2398 uint8_t *data
, Error
**errp
)
2401 NBDExport
*exp
= client
->exp
;
2403 assert(request
->type
== NBD_CMD_READ
);
2405 /* XXX: NBD Protocol only documents use of FUA with WRITE */
2406 if (request
->flags
& NBD_CMD_FLAG_FUA
) {
2407 ret
= blk_co_flush(exp
->common
.blk
);
2409 return nbd_send_generic_reply(client
, request
->handle
, ret
,
2410 "flush failed", errp
);
2414 if (client
->structured_reply
&& !(request
->flags
& NBD_CMD_FLAG_DF
) &&
2417 return nbd_co_send_sparse_read(client
, request
->handle
, request
->from
,
2418 data
, request
->len
, errp
);
2421 ret
= blk_pread(exp
->common
.blk
, request
->from
, data
, request
->len
);
2423 return nbd_send_generic_reply(client
, request
->handle
, ret
,
2424 "reading from file failed", errp
);
2427 if (client
->structured_reply
) {
2429 return nbd_co_send_structured_read(client
, request
->handle
,
2430 request
->from
, data
,
2431 request
->len
, true, errp
);
2433 return nbd_co_send_structured_done(client
, request
->handle
, errp
);
2436 return nbd_co_send_simple_reply(client
, request
->handle
, 0,
2437 data
, request
->len
, errp
);
2444 * Handle NBD_CMD_CACHE request.
2445 * Return -errno if sending fails. Other errors are reported directly to the
2446 * client as an error reply.
2448 static coroutine_fn
int nbd_do_cmd_cache(NBDClient
*client
, NBDRequest
*request
,
2452 NBDExport
*exp
= client
->exp
;
2454 assert(request
->type
== NBD_CMD_CACHE
);
2456 ret
= blk_co_preadv(exp
->common
.blk
, request
->from
, request
->len
,
2457 NULL
, BDRV_REQ_COPY_ON_READ
| BDRV_REQ_PREFETCH
);
2459 return nbd_send_generic_reply(client
, request
->handle
, ret
,
2460 "caching data failed", errp
);
2463 /* Handle NBD request.
2464 * Return -errno if sending fails. Other errors are reported directly to the
2465 * client as an error reply. */
2466 static coroutine_fn
int nbd_handle_request(NBDClient
*client
,
2467 NBDRequest
*request
,
2468 uint8_t *data
, Error
**errp
)
2472 NBDExport
*exp
= client
->exp
;
2476 switch (request
->type
) {
2478 return nbd_do_cmd_cache(client
, request
, errp
);
2481 return nbd_do_cmd_read(client
, request
, data
, errp
);
2485 if (request
->flags
& NBD_CMD_FLAG_FUA
) {
2486 flags
|= BDRV_REQ_FUA
;
2488 ret
= blk_pwrite(exp
->common
.blk
, request
->from
, data
, request
->len
,
2490 return nbd_send_generic_reply(client
, request
->handle
, ret
,
2491 "writing to file failed", errp
);
2493 case NBD_CMD_WRITE_ZEROES
:
2495 if (request
->flags
& NBD_CMD_FLAG_FUA
) {
2496 flags
|= BDRV_REQ_FUA
;
2498 if (!(request
->flags
& NBD_CMD_FLAG_NO_HOLE
)) {
2499 flags
|= BDRV_REQ_MAY_UNMAP
;
2501 if (request
->flags
& NBD_CMD_FLAG_FAST_ZERO
) {
2502 flags
|= BDRV_REQ_NO_FALLBACK
;
2505 /* FIXME simplify this when blk_pwrite_zeroes switches to 64-bit */
2506 while (ret
>= 0 && request
->len
) {
2507 int align
= client
->check_align
?: 1;
2508 int len
= MIN(request
->len
, QEMU_ALIGN_DOWN(BDRV_REQUEST_MAX_BYTES
,
2510 ret
= blk_pwrite_zeroes(exp
->common
.blk
, request
->from
, len
, flags
);
2511 request
->len
-= len
;
2512 request
->from
+= len
;
2514 return nbd_send_generic_reply(client
, request
->handle
, ret
,
2515 "writing to file failed", errp
);
2518 /* unreachable, thanks to special case in nbd_co_receive_request() */
2522 ret
= blk_co_flush(exp
->common
.blk
);
2523 return nbd_send_generic_reply(client
, request
->handle
, ret
,
2524 "flush failed", errp
);
2528 /* FIXME simplify this when blk_co_pdiscard switches to 64-bit */
2529 while (ret
>= 0 && request
->len
) {
2530 int align
= client
->check_align
?: 1;
2531 int len
= MIN(request
->len
, QEMU_ALIGN_DOWN(BDRV_REQUEST_MAX_BYTES
,
2533 ret
= blk_co_pdiscard(exp
->common
.blk
, request
->from
, len
);
2534 request
->len
-= len
;
2535 request
->from
+= len
;
2537 if (ret
>= 0 && request
->flags
& NBD_CMD_FLAG_FUA
) {
2538 ret
= blk_co_flush(exp
->common
.blk
);
2540 return nbd_send_generic_reply(client
, request
->handle
, ret
,
2541 "discard failed", errp
);
2543 case NBD_CMD_BLOCK_STATUS
:
2544 if (!request
->len
) {
2545 return nbd_send_generic_reply(client
, request
->handle
, -EINVAL
,
2546 "need non-zero length", errp
);
2548 if (client
->export_meta
.count
) {
2549 bool dont_fragment
= request
->flags
& NBD_CMD_FLAG_REQ_ONE
;
2550 int contexts_remaining
= client
->export_meta
.count
;
2552 if (client
->export_meta
.base_allocation
) {
2553 ret
= nbd_co_send_block_status(client
, request
->handle
,
2554 blk_bs(exp
->common
.blk
),
2556 request
->len
, dont_fragment
,
2557 !--contexts_remaining
,
2558 NBD_META_ID_BASE_ALLOCATION
,
2565 if (client
->export_meta
.allocation_depth
) {
2566 ret
= nbd_co_send_block_status(client
, request
->handle
,
2567 blk_bs(exp
->common
.blk
),
2568 request
->from
, request
->len
,
2570 !--contexts_remaining
,
2571 NBD_META_ID_ALLOCATION_DEPTH
,
2578 for (i
= 0; i
< client
->exp
->nr_export_bitmaps
; i
++) {
2579 if (!client
->export_meta
.bitmaps
[i
]) {
2582 ret
= nbd_co_send_bitmap(client
, request
->handle
,
2583 client
->exp
->export_bitmaps
[i
],
2584 request
->from
, request
->len
,
2585 dont_fragment
, !--contexts_remaining
,
2586 NBD_META_ID_DIRTY_BITMAP
+ i
, errp
);
2592 assert(!contexts_remaining
);
2596 return nbd_send_generic_reply(client
, request
->handle
, -EINVAL
,
2597 "CMD_BLOCK_STATUS not negotiated",
2602 msg
= g_strdup_printf("invalid request type (%" PRIu32
") received",
2604 ret
= nbd_send_generic_reply(client
, request
->handle
, -EINVAL
, msg
,
2611 /* Owns a reference to the NBDClient passed as opaque. */
2612 static coroutine_fn
void nbd_trip(void *opaque
)
2614 NBDClient
*client
= opaque
;
2615 NBDRequestData
*req
;
2616 NBDRequest request
= { 0 }; /* GCC thinks it can be used uninitialized */
2618 Error
*local_err
= NULL
;
2621 if (client
->closing
) {
2622 nbd_client_put(client
);
2626 if (client
->quiescing
) {
2628 * We're switching between AIO contexts. Don't attempt to receive a new
2629 * request and kick the main context which may be waiting for us.
2631 nbd_client_put(client
);
2632 client
->recv_coroutine
= NULL
;
2637 req
= nbd_request_get(client
);
2638 ret
= nbd_co_receive_request(req
, &request
, &local_err
);
2639 client
->recv_coroutine
= NULL
;
2641 if (client
->closing
) {
2643 * The client may be closed when we are blocked in
2644 * nbd_co_receive_request()
2649 if (ret
== -EAGAIN
) {
2650 assert(client
->quiescing
);
2654 nbd_client_receive_next_request(client
);
2660 /* It wans't -EIO, so, according to nbd_co_receive_request()
2661 * semantics, we should return the error to the client. */
2662 Error
*export_err
= local_err
;
2665 ret
= nbd_send_generic_reply(client
, request
.handle
, -EINVAL
,
2666 error_get_pretty(export_err
), &local_err
);
2667 error_free(export_err
);
2669 ret
= nbd_handle_request(client
, &request
, req
->data
, &local_err
);
2672 error_prepend(&local_err
, "Failed to send reply: ");
2676 /* We must disconnect after NBD_CMD_WRITE if we did not
2679 if (!req
->complete
) {
2680 error_setg(&local_err
, "Request handling failed in intermediate state");
2685 nbd_request_put(req
);
2686 nbd_client_put(client
);
2691 error_reportf_err(local_err
, "Disconnect client, due to: ");
2693 nbd_request_put(req
);
2694 client_close(client
, true);
2695 nbd_client_put(client
);
2698 static void nbd_client_receive_next_request(NBDClient
*client
)
2700 if (!client
->recv_coroutine
&& client
->nb_requests
< MAX_NBD_REQUESTS
&&
2701 !client
->quiescing
) {
2702 nbd_client_get(client
);
2703 client
->recv_coroutine
= qemu_coroutine_create(nbd_trip
, client
);
2704 aio_co_schedule(client
->exp
->common
.ctx
, client
->recv_coroutine
);
2708 static coroutine_fn
void nbd_co_client_start(void *opaque
)
2710 NBDClient
*client
= opaque
;
2711 Error
*local_err
= NULL
;
2713 qemu_co_mutex_init(&client
->send_lock
);
2715 if (nbd_negotiate(client
, &local_err
)) {
2717 error_report_err(local_err
);
2719 client_close(client
, false);
2723 nbd_client_receive_next_request(client
);
2727 * Create a new client listener using the given channel @sioc.
2728 * Begin servicing it in a coroutine. When the connection closes, call
2729 * @close_fn with an indication of whether the client completed negotiation.
2731 void nbd_client_new(QIOChannelSocket
*sioc
,
2732 QCryptoTLSCreds
*tlscreds
,
2733 const char *tlsauthz
,
2734 void (*close_fn
)(NBDClient
*, bool))
2739 client
= g_new0(NBDClient
, 1);
2740 client
->refcount
= 1;
2741 client
->tlscreds
= tlscreds
;
2743 object_ref(OBJECT(client
->tlscreds
));
2745 client
->tlsauthz
= g_strdup(tlsauthz
);
2746 client
->sioc
= sioc
;
2747 object_ref(OBJECT(client
->sioc
));
2748 client
->ioc
= QIO_CHANNEL(sioc
);
2749 object_ref(OBJECT(client
->ioc
));
2750 client
->close_fn
= close_fn
;
2752 co
= qemu_coroutine_create(nbd_co_client_start
, client
);
2753 qemu_coroutine_enter(co
);