2 * Copyright (C) 2016-2017 Red Hat, Inc.
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"
21 #include "qapi/error.h"
23 #include "nbd-internal.h"
25 static int system_errno_to_nbd_errno(int err)
51 /* Definitions for opaque data types */
53 typedef struct NBDRequestData NBDRequestData;
55 struct NBDRequestData {
56 QSIMPLEQ_ENTRY(NBDRequestData) entry;
64 void (*close)(NBDExport *exp);
72 QTAILQ_HEAD(, NBDClient) clients;
73 QTAILQ_ENTRY(NBDExport) next;
77 BlockBackend *eject_notifier_blk;
78 Notifier eject_notifier;
81 static QTAILQ_HEAD(, NBDExport) exports = QTAILQ_HEAD_INITIALIZER(exports);
85 void (*close_fn)(NBDClient *client, bool negotiated);
88 QCryptoTLSCreds *tlscreds;
90 QIOChannelSocket *sioc; /* The underlying data channel */
91 QIOChannel *ioc; /* The current I/O channel which may differ (eg TLS) */
93 Coroutine *recv_coroutine;
96 Coroutine *send_coroutine;
98 QTAILQ_ENTRY(NBDClient) next;
103 /* That's all folks */
105 static void nbd_client_receive_next_request(NBDClient *client);
107 /* Basic flow for negotiation
134 /* Send a reply header, including length, but no payload.
135 * Return -errno on error, 0 on success. */
136 static int nbd_negotiate_send_rep_len(QIOChannel *ioc, uint32_t type,
137 uint32_t opt, uint32_t len, Error **errp)
141 trace_nbd_negotiate_send_rep_len(opt, nbd_opt_lookup(opt),
142 type, nbd_rep_lookup(type), len);
144 assert(len < NBD_MAX_BUFFER_SIZE);
145 magic = cpu_to_be64(NBD_REP_MAGIC);
146 if (nbd_write(ioc, &magic, sizeof(magic), errp) < 0) {
147 error_prepend(errp, "write failed (rep magic): ");
151 opt = cpu_to_be32(opt);
152 if (nbd_write(ioc, &opt, sizeof(opt), errp) < 0) {
153 error_prepend(errp, "write failed (rep opt): ");
157 type = cpu_to_be32(type);
158 if (nbd_write(ioc, &type, sizeof(type), errp) < 0) {
159 error_prepend(errp, "write failed (rep type): ");
163 len = cpu_to_be32(len);
164 if (nbd_write(ioc, &len, sizeof(len), errp) < 0) {
165 error_prepend(errp, "write failed (rep data length): ");
171 /* Send a reply header with default 0 length.
172 * Return -errno on error, 0 on success. */
173 static int nbd_negotiate_send_rep(QIOChannel *ioc, uint32_t type, uint32_t opt,
176 return nbd_negotiate_send_rep_len(ioc, type, opt, 0, errp);
179 /* Send an error reply.
180 * Return -errno on error, 0 on success. */
181 static int GCC_FMT_ATTR(5, 6)
182 nbd_negotiate_send_rep_err(QIOChannel *ioc, uint32_t type,
183 uint32_t opt, Error **errp, const char *fmt, ...)
191 msg = g_strdup_vprintf(fmt, va);
195 trace_nbd_negotiate_send_rep_err(msg);
196 ret = nbd_negotiate_send_rep_len(ioc, type, opt, len, errp);
200 if (nbd_write(ioc, msg, len, errp) < 0) {
201 error_prepend(errp, "write failed (error message): ");
212 /* Send a single NBD_REP_SERVER reply to NBD_OPT_LIST, including payload.
213 * Return -errno on error, 0 on success. */
214 static int nbd_negotiate_send_rep_list(QIOChannel *ioc, NBDExport *exp,
217 size_t name_len, desc_len;
219 const char *name = exp->name ? exp->name : "";
220 const char *desc = exp->description ? exp->description : "";
223 trace_nbd_negotiate_send_rep_list(name, desc);
224 name_len = strlen(name);
225 desc_len = strlen(desc);
226 len = name_len + desc_len + sizeof(len);
227 ret = nbd_negotiate_send_rep_len(ioc, NBD_REP_SERVER, NBD_OPT_LIST, len,
233 len = cpu_to_be32(name_len);
234 if (nbd_write(ioc, &len, sizeof(len), errp) < 0) {
235 error_prepend(errp, "write failed (name length): ");
239 if (nbd_write(ioc, name, name_len, errp) < 0) {
240 error_prepend(errp, "write failed (name buffer): ");
244 if (nbd_write(ioc, desc, desc_len, errp) < 0) {
245 error_prepend(errp, "write failed (description buffer): ");
252 /* Process the NBD_OPT_LIST command, with a potential series of replies.
253 * Return -errno on error, 0 on success. */
254 static int nbd_negotiate_handle_list(NBDClient *client, uint32_t length,
260 if (nbd_drop(client->ioc, length, errp) < 0) {
263 return nbd_negotiate_send_rep_err(client->ioc,
264 NBD_REP_ERR_INVALID, NBD_OPT_LIST,
266 "OPT_LIST should not have length");
269 /* For each export, send a NBD_REP_SERVER reply. */
270 QTAILQ_FOREACH(exp, &exports, next) {
271 if (nbd_negotiate_send_rep_list(client->ioc, exp, errp)) {
275 /* Finish with a NBD_REP_ACK. */
276 return nbd_negotiate_send_rep(client->ioc, NBD_REP_ACK, NBD_OPT_LIST, errp);
279 /* Send a reply to NBD_OPT_EXPORT_NAME.
280 * Return -errno on error, 0 on success. */
281 static int nbd_negotiate_handle_export_name(NBDClient *client, uint32_t length,
282 uint16_t myflags, bool no_zeroes,
285 char name[NBD_MAX_NAME_SIZE + 1];
286 char buf[8 + 4 + 124] = "";
291 [20 .. xx] export name (length bytes)
293 trace_nbd_negotiate_handle_export_name();
294 if (length >= sizeof(name)) {
295 error_setg(errp, "Bad length received");
298 if (nbd_read(client->ioc, name, length, errp) < 0) {
299 error_prepend(errp, "read failed: ");
304 trace_nbd_negotiate_handle_export_name_request(name);
306 client->exp = nbd_export_find(name);
308 error_setg(errp, "export not found");
312 trace_nbd_negotiate_new_style_size_flags(client->exp->size,
313 client->exp->nbdflags | myflags);
314 stq_be_p(buf, client->exp->size);
315 stw_be_p(buf + 8, client->exp->nbdflags | myflags);
316 len = no_zeroes ? 10 : sizeof(buf);
317 ret = nbd_write(client->ioc, buf, len, errp);
319 error_prepend(errp, "write failed: ");
323 QTAILQ_INSERT_TAIL(&client->exp->clients, client, next);
324 nbd_export_get(client->exp);
329 /* Send a single NBD_REP_INFO, with a buffer @buf of @length bytes.
330 * The buffer does NOT include the info type prefix.
331 * Return -errno on error, 0 if ready to send more. */
332 static int nbd_negotiate_send_info(NBDClient *client, uint32_t opt,
333 uint16_t info, uint32_t length, void *buf,
338 trace_nbd_negotiate_send_info(info, nbd_info_lookup(info), length);
339 rc = nbd_negotiate_send_rep_len(client->ioc, NBD_REP_INFO, opt,
340 sizeof(info) + length, errp);
345 if (nbd_write(client->ioc, &info, sizeof(info), errp) < 0) {
348 if (nbd_write(client->ioc, buf, length, errp) < 0) {
354 /* Handle NBD_OPT_INFO and NBD_OPT_GO.
355 * Return -errno on error, 0 if ready for next option, and 1 to move
356 * into transmission phase. */
357 static int nbd_negotiate_handle_info(NBDClient *client, uint32_t length,
358 uint32_t opt, uint16_t myflags,
362 char name[NBD_MAX_NAME_SIZE + 1];
367 bool sendname = false;
368 char buf[sizeof(uint64_t) + sizeof(uint16_t)];
372 4 bytes: L, name length (can be 0)
374 2 bytes: N, number of requests (can be 0)
375 N * 2 bytes: N requests
377 if (length < sizeof(namelen) + sizeof(requests)) {
378 msg = "overall request too short";
381 if (nbd_read(client->ioc, &namelen, sizeof(namelen), errp) < 0) {
384 be32_to_cpus(&namelen);
385 length -= sizeof(namelen);
386 if (namelen > length - sizeof(requests) || (length - namelen) % 2) {
387 msg = "name length is incorrect";
390 if (nbd_read(client->ioc, name, namelen, errp) < 0) {
393 name[namelen] = '\0';
395 trace_nbd_negotiate_handle_export_name_request(name);
397 if (nbd_read(client->ioc, &requests, sizeof(requests), errp) < 0) {
400 be16_to_cpus(&requests);
401 length -= sizeof(requests);
402 trace_nbd_negotiate_handle_info_requests(requests);
403 if (requests != length / sizeof(request)) {
404 msg = "incorrect number of requests for overall length";
408 if (nbd_read(client->ioc, &request, sizeof(request), errp) < 0) {
411 be16_to_cpus(&request);
412 length -= sizeof(request);
413 trace_nbd_negotiate_handle_info_request(request,
414 nbd_info_lookup(request));
415 /* For now, we only care about NBD_INFO_NAME; everything else
416 * is either a request we don't know or something we send
417 * regardless of request. */
418 if (request == NBD_INFO_NAME) {
423 exp = nbd_export_find(name);
425 return nbd_negotiate_send_rep_err(client->ioc, NBD_REP_ERR_UNKNOWN,
426 opt, errp, "export '%s' not present",
430 /* Don't bother sending NBD_INFO_NAME unless client requested it */
432 rc = nbd_negotiate_send_info(client, opt, NBD_INFO_NAME, length, name,
439 /* Send NBD_INFO_DESCRIPTION only if available, regardless of
441 if (exp->description) {
442 size_t len = strlen(exp->description);
444 rc = nbd_negotiate_send_info(client, opt, NBD_INFO_DESCRIPTION,
445 len, exp->description, errp);
451 /* Send NBD_INFO_EXPORT always */
452 trace_nbd_negotiate_new_style_size_flags(exp->size,
453 exp->nbdflags | myflags);
454 stq_be_p(buf, exp->size);
455 stw_be_p(buf + 8, exp->nbdflags | myflags);
456 rc = nbd_negotiate_send_info(client, opt, NBD_INFO_EXPORT,
457 sizeof(buf), buf, errp);
463 rc = nbd_negotiate_send_rep(client->ioc, NBD_REP_ACK, opt, errp);
468 if (opt == NBD_OPT_GO) {
470 QTAILQ_INSERT_TAIL(&client->exp->clients, client, next);
471 nbd_export_get(client->exp);
477 if (nbd_drop(client->ioc, length, errp) < 0) {
480 return nbd_negotiate_send_rep_err(client->ioc, NBD_REP_ERR_INVALID, opt,
485 /* Handle NBD_OPT_STARTTLS. Return NULL to drop connection, or else the
486 * new channel for all further (now-encrypted) communication. */
487 static QIOChannel *nbd_negotiate_handle_starttls(NBDClient *client,
493 struct NBDTLSHandshakeData data = { 0 };
495 trace_nbd_negotiate_handle_starttls();
498 if (nbd_drop(ioc, length, errp) < 0) {
501 nbd_negotiate_send_rep_err(ioc, NBD_REP_ERR_INVALID, NBD_OPT_STARTTLS,
503 "OPT_STARTTLS should not have length");
507 if (nbd_negotiate_send_rep(client->ioc, NBD_REP_ACK,
508 NBD_OPT_STARTTLS, errp) < 0) {
512 tioc = qio_channel_tls_new_server(ioc,
520 qio_channel_set_name(QIO_CHANNEL(tioc), "nbd-server-tls");
521 trace_nbd_negotiate_handle_starttls_handshake();
522 data.loop = g_main_loop_new(g_main_context_default(), FALSE);
523 qio_channel_tls_handshake(tioc,
528 if (!data.complete) {
529 g_main_loop_run(data.loop);
531 g_main_loop_unref(data.loop);
533 object_unref(OBJECT(tioc));
534 error_propagate(errp, data.error);
538 return QIO_CHANNEL(tioc);
541 /* nbd_negotiate_options
542 * Process all NBD_OPT_* client option commands, during fixed newstyle
545 * -errno on error, errp is set
546 * 0 on successful negotiation, errp is not set
547 * 1 if client sent NBD_OPT_ABORT, i.e. on valid disconnect,
550 static int nbd_negotiate_options(NBDClient *client, uint16_t myflags,
554 bool fixedNewstyle = false;
555 bool no_zeroes = false;
558 [ 0 .. 3] client flags
560 Then we loop until NBD_OPT_EXPORT_NAME or NBD_OPT_GO:
561 [ 0 .. 7] NBD_OPTS_MAGIC
562 [ 8 .. 11] NBD option
563 [12 .. 15] Data length
566 [ 0 .. 7] NBD_OPTS_MAGIC
567 [ 8 .. 11] Second NBD option
568 [12 .. 15] Data length
572 if (nbd_read(client->ioc, &flags, sizeof(flags), errp) < 0) {
573 error_prepend(errp, "read failed: ");
576 be32_to_cpus(&flags);
577 trace_nbd_negotiate_options_flags(flags);
578 if (flags & NBD_FLAG_C_FIXED_NEWSTYLE) {
579 fixedNewstyle = true;
580 flags &= ~NBD_FLAG_C_FIXED_NEWSTYLE;
582 if (flags & NBD_FLAG_C_NO_ZEROES) {
584 flags &= ~NBD_FLAG_C_NO_ZEROES;
587 error_setg(errp, "Unknown client flags 0x%" PRIx32 " received", flags);
593 uint32_t option, length;
596 if (nbd_read(client->ioc, &magic, sizeof(magic), errp) < 0) {
597 error_prepend(errp, "read failed: ");
600 magic = be64_to_cpu(magic);
601 trace_nbd_negotiate_options_check_magic(magic);
602 if (magic != NBD_OPTS_MAGIC) {
603 error_setg(errp, "Bad magic received");
607 if (nbd_read(client->ioc, &option,
608 sizeof(option), errp) < 0) {
609 error_prepend(errp, "read failed: ");
612 option = be32_to_cpu(option);
614 if (nbd_read(client->ioc, &length, sizeof(length), errp) < 0) {
615 error_prepend(errp, "read failed: ");
618 length = be32_to_cpu(length);
620 trace_nbd_negotiate_options_check_option(option,
621 nbd_opt_lookup(option));
622 if (client->tlscreds &&
623 client->ioc == (QIOChannel *)client->sioc) {
625 if (!fixedNewstyle) {
626 error_setg(errp, "Unsupported option 0x%" PRIx32, option);
630 case NBD_OPT_STARTTLS:
631 tioc = nbd_negotiate_handle_starttls(client, length, errp);
635 object_unref(OBJECT(client->ioc));
636 client->ioc = QIO_CHANNEL(tioc);
639 case NBD_OPT_EXPORT_NAME:
640 /* No way to return an error to client, so drop connection */
641 error_setg(errp, "Option 0x%x not permitted before TLS",
646 if (nbd_drop(client->ioc, length, errp) < 0) {
649 ret = nbd_negotiate_send_rep_err(client->ioc,
650 NBD_REP_ERR_TLS_REQD,
653 "not permitted before TLS",
658 /* Let the client keep trying, unless they asked to
659 * quit. In this mode, we've already sent an error, so
660 * we can't ack the abort. */
661 if (option == NBD_OPT_ABORT) {
666 } else if (fixedNewstyle) {
669 ret = nbd_negotiate_handle_list(client, length, errp);
676 /* NBD spec says we must try to reply before
677 * disconnecting, but that we must also tolerate
678 * guests that don't wait for our reply. */
679 nbd_negotiate_send_rep(client->ioc, NBD_REP_ACK, option, NULL);
682 case NBD_OPT_EXPORT_NAME:
683 return nbd_negotiate_handle_export_name(client, length,
689 ret = nbd_negotiate_handle_info(client, length, option,
692 assert(option == NBD_OPT_GO);
700 case NBD_OPT_STARTTLS:
701 if (nbd_drop(client->ioc, length, errp) < 0) {
704 if (client->tlscreds) {
705 ret = nbd_negotiate_send_rep_err(client->ioc,
708 "TLS already enabled");
710 ret = nbd_negotiate_send_rep_err(client->ioc,
713 "TLS not configured");
720 if (nbd_drop(client->ioc, length, errp) < 0) {
723 ret = nbd_negotiate_send_rep_err(client->ioc,
726 "Unsupported option 0x%"
727 PRIx32 " (%s)", option,
728 nbd_opt_lookup(option));
736 * If broken new-style we should drop the connection
737 * for anything except NBD_OPT_EXPORT_NAME
740 case NBD_OPT_EXPORT_NAME:
741 return nbd_negotiate_handle_export_name(client, length,
746 error_setg(errp, "Unsupported option 0x%" PRIx32 " (%s)",
747 option, nbd_opt_lookup(option));
756 * -errno on error, errp is set
757 * 0 on successful negotiation, errp is not set
758 * 1 if client sent NBD_OPT_ABORT, i.e. on valid disconnect,
761 static coroutine_fn int nbd_negotiate(NBDClient *client, Error **errp)
763 char buf[8 + 8 + 8 + 128];
765 const uint16_t myflags = (NBD_FLAG_HAS_FLAGS | NBD_FLAG_SEND_TRIM |
766 NBD_FLAG_SEND_FLUSH | NBD_FLAG_SEND_FUA |
767 NBD_FLAG_SEND_WRITE_ZEROES);
770 /* Old style negotiation header without options
771 [ 0 .. 7] passwd ("NBDMAGIC")
772 [ 8 .. 15] magic (NBD_CLIENT_MAGIC)
774 [24 .. 25] server flags (0)
775 [26 .. 27] export flags
776 [28 .. 151] reserved (0)
778 New style negotiation header with options
779 [ 0 .. 7] passwd ("NBDMAGIC")
780 [ 8 .. 15] magic (NBD_OPTS_MAGIC)
781 [16 .. 17] server flags (0)
782 ....options sent, ending in NBD_OPT_EXPORT_NAME or NBD_OPT_GO....
785 qio_channel_set_blocking(client->ioc, false, NULL);
787 trace_nbd_negotiate_begin();
788 memset(buf, 0, sizeof(buf));
789 memcpy(buf, "NBDMAGIC", 8);
791 oldStyle = client->exp != NULL && !client->tlscreds;
793 trace_nbd_negotiate_old_style(client->exp->size,
794 client->exp->nbdflags | myflags);
795 stq_be_p(buf + 8, NBD_CLIENT_MAGIC);
796 stq_be_p(buf + 16, client->exp->size);
797 stw_be_p(buf + 26, client->exp->nbdflags | myflags);
799 if (nbd_write(client->ioc, buf, sizeof(buf), errp) < 0) {
800 error_prepend(errp, "write failed: ");
804 stq_be_p(buf + 8, NBD_OPTS_MAGIC);
805 stw_be_p(buf + 16, NBD_FLAG_FIXED_NEWSTYLE | NBD_FLAG_NO_ZEROES);
807 if (nbd_write(client->ioc, buf, 18, errp) < 0) {
808 error_prepend(errp, "write failed: ");
811 ret = nbd_negotiate_options(client, myflags, errp);
814 error_prepend(errp, "option negotiation failed: ");
820 trace_nbd_negotiate_success();
825 static int nbd_receive_request(QIOChannel *ioc, NBDRequest *request,
828 uint8_t buf[NBD_REQUEST_SIZE];
832 ret = nbd_read(ioc, buf, sizeof(buf), errp);
838 [ 0 .. 3] magic (NBD_REQUEST_MAGIC)
839 [ 4 .. 5] flags (NBD_CMD_FLAG_FUA, ...)
840 [ 6 .. 7] type (NBD_CMD_READ, ...)
846 magic = ldl_be_p(buf);
847 request->flags = lduw_be_p(buf + 4);
848 request->type = lduw_be_p(buf + 6);
849 request->handle = ldq_be_p(buf + 8);
850 request->from = ldq_be_p(buf + 16);
851 request->len = ldl_be_p(buf + 24);
853 trace_nbd_receive_request(magic, request->flags, request->type,
854 request->from, request->len);
856 if (magic != NBD_REQUEST_MAGIC) {
857 error_setg(errp, "invalid magic (got 0x%" PRIx32 ")", magic);
863 static int nbd_send_reply(QIOChannel *ioc, NBDReply *reply, Error **errp)
865 uint8_t buf[NBD_REPLY_SIZE];
867 reply->error = system_errno_to_nbd_errno(reply->error);
869 trace_nbd_send_reply(reply->error, reply->handle);
872 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
873 [ 4 .. 7] error (0 == no error)
876 stl_be_p(buf, NBD_REPLY_MAGIC);
877 stl_be_p(buf + 4, reply->error);
878 stq_be_p(buf + 8, reply->handle);
880 return nbd_write(ioc, buf, sizeof(buf), errp);
883 #define MAX_NBD_REQUESTS 16
885 void nbd_client_get(NBDClient *client)
890 void nbd_client_put(NBDClient *client)
892 if (--client->refcount == 0) {
893 /* The last reference should be dropped by client->close,
894 * which is called by client_close.
896 assert(client->closing);
898 qio_channel_detach_aio_context(client->ioc);
899 object_unref(OBJECT(client->sioc));
900 object_unref(OBJECT(client->ioc));
901 if (client->tlscreds) {
902 object_unref(OBJECT(client->tlscreds));
904 g_free(client->tlsaclname);
906 QTAILQ_REMOVE(&client->exp->clients, client, next);
907 nbd_export_put(client->exp);
913 static void client_close(NBDClient *client, bool negotiated)
915 if (client->closing) {
919 client->closing = true;
921 /* Force requests to finish. They will drop their own references,
922 * then we'll close the socket and free the NBDClient.
924 qio_channel_shutdown(client->ioc, QIO_CHANNEL_SHUTDOWN_BOTH,
927 /* Also tell the client, so that they release their reference. */
928 if (client->close_fn) {
929 client->close_fn(client, negotiated);
933 static NBDRequestData *nbd_request_get(NBDClient *client)
937 assert(client->nb_requests <= MAX_NBD_REQUESTS - 1);
938 client->nb_requests++;
940 req = g_new0(NBDRequestData, 1);
941 nbd_client_get(client);
942 req->client = client;
946 static void nbd_request_put(NBDRequestData *req)
948 NBDClient *client = req->client;
951 qemu_vfree(req->data);
955 client->nb_requests--;
956 nbd_client_receive_next_request(client);
958 nbd_client_put(client);
961 static void blk_aio_attached(AioContext *ctx, void *opaque)
963 NBDExport *exp = opaque;
966 trace_nbd_blk_aio_attached(exp->name, ctx);
970 QTAILQ_FOREACH(client, &exp->clients, next) {
971 qio_channel_attach_aio_context(client->ioc, ctx);
972 if (client->recv_coroutine) {
973 aio_co_schedule(ctx, client->recv_coroutine);
975 if (client->send_coroutine) {
976 aio_co_schedule(ctx, client->send_coroutine);
981 static void blk_aio_detach(void *opaque)
983 NBDExport *exp = opaque;
986 trace_nbd_blk_aio_detach(exp->name, exp->ctx);
988 QTAILQ_FOREACH(client, &exp->clients, next) {
989 qio_channel_detach_aio_context(client->ioc);
995 static void nbd_eject_notifier(Notifier *n, void *data)
997 NBDExport *exp = container_of(n, NBDExport, eject_notifier);
998 nbd_export_close(exp);
1001 NBDExport *nbd_export_new(BlockDriverState *bs, off_t dev_offset, off_t size,
1002 uint16_t nbdflags, void (*close)(NBDExport *),
1003 bool writethrough, BlockBackend *on_eject_blk,
1007 NBDExport *exp = g_malloc0(sizeof(NBDExport));
1011 /* Don't allow resize while the NBD server is running, otherwise we don't
1012 * care what happens with the node. */
1013 perm = BLK_PERM_CONSISTENT_READ;
1014 if ((nbdflags & NBD_FLAG_READ_ONLY) == 0) {
1015 perm |= BLK_PERM_WRITE;
1017 blk = blk_new(perm, BLK_PERM_CONSISTENT_READ | BLK_PERM_WRITE_UNCHANGED |
1018 BLK_PERM_WRITE | BLK_PERM_GRAPH_MOD);
1019 ret = blk_insert_bs(blk, bs, errp);
1023 blk_set_enable_write_cache(blk, !writethrough);
1026 QTAILQ_INIT(&exp->clients);
1028 exp->dev_offset = dev_offset;
1029 exp->nbdflags = nbdflags;
1030 exp->size = size < 0 ? blk_getlength(blk) : size;
1031 if (exp->size < 0) {
1032 error_setg_errno(errp, -exp->size,
1033 "Failed to determine the NBD export's length");
1036 exp->size -= exp->size % BDRV_SECTOR_SIZE;
1039 exp->ctx = blk_get_aio_context(blk);
1040 blk_add_aio_context_notifier(blk, blk_aio_attached, blk_aio_detach, exp);
1043 blk_ref(on_eject_blk);
1044 exp->eject_notifier_blk = on_eject_blk;
1045 exp->eject_notifier.notify = nbd_eject_notifier;
1046 blk_add_remove_bs_notifier(on_eject_blk, &exp->eject_notifier);
1050 * NBD exports are used for non-shared storage migration. Make sure
1051 * that BDRV_O_INACTIVE is cleared and the image is ready for write
1052 * access since the export could be available before migration handover.
1054 aio_context_acquire(exp->ctx);
1055 blk_invalidate_cache(blk, NULL);
1056 aio_context_release(exp->ctx);
1065 NBDExport *nbd_export_find(const char *name)
1068 QTAILQ_FOREACH(exp, &exports, next) {
1069 if (strcmp(name, exp->name) == 0) {
1077 void nbd_export_set_name(NBDExport *exp, const char *name)
1079 if (exp->name == name) {
1083 nbd_export_get(exp);
1084 if (exp->name != NULL) {
1087 QTAILQ_REMOVE(&exports, exp, next);
1088 nbd_export_put(exp);
1091 nbd_export_get(exp);
1092 exp->name = g_strdup(name);
1093 QTAILQ_INSERT_TAIL(&exports, exp, next);
1095 nbd_export_put(exp);
1098 void nbd_export_set_description(NBDExport *exp, const char *description)
1100 g_free(exp->description);
1101 exp->description = g_strdup(description);
1104 void nbd_export_close(NBDExport *exp)
1106 NBDClient *client, *next;
1108 nbd_export_get(exp);
1109 QTAILQ_FOREACH_SAFE(client, &exp->clients, next, next) {
1110 client_close(client, true);
1112 nbd_export_set_name(exp, NULL);
1113 nbd_export_set_description(exp, NULL);
1114 nbd_export_put(exp);
1117 void nbd_export_get(NBDExport *exp)
1119 assert(exp->refcount > 0);
1123 void nbd_export_put(NBDExport *exp)
1125 assert(exp->refcount > 0);
1126 if (exp->refcount == 1) {
1127 nbd_export_close(exp);
1130 if (--exp->refcount == 0) {
1131 assert(exp->name == NULL);
1132 assert(exp->description == NULL);
1139 if (exp->eject_notifier_blk) {
1140 notifier_remove(&exp->eject_notifier);
1141 blk_unref(exp->eject_notifier_blk);
1143 blk_remove_aio_context_notifier(exp->blk, blk_aio_attached,
1144 blk_aio_detach, exp);
1145 blk_unref(exp->blk);
1153 BlockBackend *nbd_export_get_blockdev(NBDExport *exp)
1158 void nbd_export_close_all(void)
1160 NBDExport *exp, *next;
1162 QTAILQ_FOREACH_SAFE(exp, &exports, next, next) {
1163 nbd_export_close(exp);
1167 static int nbd_co_send_reply(NBDRequestData *req, NBDReply *reply, int len,
1170 NBDClient *client = req->client;
1173 g_assert(qemu_in_coroutine());
1175 trace_nbd_co_send_reply(reply->handle, reply->error, len);
1177 qemu_co_mutex_lock(&client->send_lock);
1178 client->send_coroutine = qemu_coroutine_self();
1181 ret = nbd_send_reply(client->ioc, reply, errp);
1183 qio_channel_set_cork(client->ioc, true);
1184 ret = nbd_send_reply(client->ioc, reply, errp);
1186 ret = nbd_write(client->ioc, req->data, len, errp);
1191 qio_channel_set_cork(client->ioc, false);
1194 client->send_coroutine = NULL;
1195 qemu_co_mutex_unlock(&client->send_lock);
1199 /* nbd_co_receive_request
1200 * Collect a client request. Return 0 if request looks valid, -EIO to drop
1201 * connection right away, and any other negative value to report an error to
1202 * the client (although the caller may still need to disconnect after reporting
1205 static int nbd_co_receive_request(NBDRequestData *req, NBDRequest *request,
1208 NBDClient *client = req->client;
1210 g_assert(qemu_in_coroutine());
1211 assert(client->recv_coroutine == qemu_coroutine_self());
1212 if (nbd_receive_request(client->ioc, request, errp) < 0) {
1216 trace_nbd_co_receive_request_decode_type(request->handle, request->type,
1217 nbd_cmd_lookup(request->type));
1219 if (request->type != NBD_CMD_WRITE) {
1220 /* No payload, we are ready to read the next request. */
1221 req->complete = true;
1224 if (request->type == NBD_CMD_DISC) {
1225 /* Special case: we're going to disconnect without a reply,
1226 * whether or not flags, from, or len are bogus */
1230 /* Check for sanity in the parameters, part 1. Defer as many
1231 * checks as possible until after reading any NBD_CMD_WRITE
1232 * payload, so we can try and keep the connection alive. */
1233 if ((request->from + request->len) < request->from) {
1235 "integer overflow detected, you're probably being attacked");
1239 if (request->type == NBD_CMD_READ || request->type == NBD_CMD_WRITE) {
1240 if (request->len > NBD_MAX_BUFFER_SIZE) {
1241 error_setg(errp, "len (%" PRIu32" ) is larger than max len (%u)",
1242 request->len, NBD_MAX_BUFFER_SIZE);
1246 req->data = blk_try_blockalign(client->exp->blk, request->len);
1247 if (req->data == NULL) {
1248 error_setg(errp, "No memory");
1252 if (request->type == NBD_CMD_WRITE) {
1253 if (nbd_read(client->ioc, req->data, request->len, errp) < 0) {
1254 error_prepend(errp, "reading from socket failed: ");
1257 req->complete = true;
1259 trace_nbd_co_receive_request_payload_received(request->handle,
1263 /* Sanity checks, part 2. */
1264 if (request->from + request->len > client->exp->size) {
1265 error_setg(errp, "operation past EOF; From: %" PRIu64 ", Len: %" PRIu32
1266 ", Size: %" PRIu64, request->from, request->len,
1267 (uint64_t)client->exp->size);
1268 return request->type == NBD_CMD_WRITE ? -ENOSPC : -EINVAL;
1270 if (request->flags & ~(NBD_CMD_FLAG_FUA | NBD_CMD_FLAG_NO_HOLE)) {
1271 error_setg(errp, "unsupported flags (got 0x%x)", request->flags);
1274 if (request->type != NBD_CMD_WRITE_ZEROES &&
1275 (request->flags & NBD_CMD_FLAG_NO_HOLE)) {
1276 error_setg(errp, "unexpected flags (got 0x%x)", request->flags);
1283 /* Owns a reference to the NBDClient passed as opaque. */
1284 static coroutine_fn void nbd_trip(void *opaque)
1286 NBDClient *client = opaque;
1287 NBDExport *exp = client->exp;
1288 NBDRequestData *req;
1289 NBDRequest request = { 0 }; /* GCC thinks it can be used uninitialized */
1293 int reply_data_len = 0;
1294 Error *local_err = NULL;
1297 if (client->closing) {
1298 nbd_client_put(client);
1302 req = nbd_request_get(client);
1303 ret = nbd_co_receive_request(req, &request, &local_err);
1304 client->recv_coroutine = NULL;
1305 nbd_client_receive_next_request(client);
1310 reply.handle = request.handle;
1318 if (client->closing) {
1320 * The client may be closed when we are blocked in
1321 * nbd_co_receive_request()
1326 switch (request.type) {
1328 /* XXX: NBD Protocol only documents use of FUA with WRITE */
1329 if (request.flags & NBD_CMD_FLAG_FUA) {
1330 ret = blk_co_flush(exp->blk);
1332 error_setg_errno(&local_err, -ret, "flush failed");
1338 ret = blk_pread(exp->blk, request.from + exp->dev_offset,
1339 req->data, request.len);
1341 error_setg_errno(&local_err, -ret, "reading from file failed");
1346 reply_data_len = request.len;
1350 if (exp->nbdflags & NBD_FLAG_READ_ONLY) {
1351 reply.error = EROFS;
1356 if (request.flags & NBD_CMD_FLAG_FUA) {
1357 flags |= BDRV_REQ_FUA;
1359 ret = blk_pwrite(exp->blk, request.from + exp->dev_offset,
1360 req->data, request.len, flags);
1362 error_setg_errno(&local_err, -ret, "writing to file failed");
1367 case NBD_CMD_WRITE_ZEROES:
1368 if (exp->nbdflags & NBD_FLAG_READ_ONLY) {
1369 error_setg(&local_err, "Server is read-only, return error");
1370 reply.error = EROFS;
1375 if (request.flags & NBD_CMD_FLAG_FUA) {
1376 flags |= BDRV_REQ_FUA;
1378 if (!(request.flags & NBD_CMD_FLAG_NO_HOLE)) {
1379 flags |= BDRV_REQ_MAY_UNMAP;
1381 ret = blk_pwrite_zeroes(exp->blk, request.from + exp->dev_offset,
1382 request.len, flags);
1384 error_setg_errno(&local_err, -ret, "writing to file failed");
1390 /* unreachable, thanks to special case in nbd_co_receive_request() */
1394 ret = blk_co_flush(exp->blk);
1396 error_setg_errno(&local_err, -ret, "flush failed");
1402 ret = blk_co_pdiscard(exp->blk, request.from + exp->dev_offset,
1405 error_setg_errno(&local_err, -ret, "discard failed");
1411 error_setg(&local_err, "invalid request type (%" PRIu32 ") received",
1413 reply.error = EINVAL;
1418 /* If we are here local_err is not fatal error, already stored in
1420 error_report_err(local_err);
1424 if (nbd_co_send_reply(req, &reply, reply_data_len, &local_err) < 0) {
1425 error_prepend(&local_err, "Failed to send reply: ");
1429 /* We must disconnect after NBD_CMD_WRITE if we did not
1432 if (!req->complete) {
1433 error_setg(&local_err, "Request handling failed in intermediate state");
1438 nbd_request_put(req);
1439 nbd_client_put(client);
1444 error_reportf_err(local_err, "Disconnect client, due to: ");
1446 nbd_request_put(req);
1447 client_close(client, true);
1448 nbd_client_put(client);
1451 static void nbd_client_receive_next_request(NBDClient *client)
1453 if (!client->recv_coroutine && client->nb_requests < MAX_NBD_REQUESTS) {
1454 nbd_client_get(client);
1455 client->recv_coroutine = qemu_coroutine_create(nbd_trip, client);
1456 aio_co_schedule(client->exp->ctx, client->recv_coroutine);
1460 static coroutine_fn void nbd_co_client_start(void *opaque)
1462 NBDClient *client = opaque;
1463 NBDExport *exp = client->exp;
1464 Error *local_err = NULL;
1467 nbd_export_get(exp);
1468 QTAILQ_INSERT_TAIL(&exp->clients, client, next);
1470 qemu_co_mutex_init(&client->send_lock);
1472 if (nbd_negotiate(client, &local_err)) {
1474 error_report_err(local_err);
1476 client_close(client, false);
1480 nbd_client_receive_next_request(client);
1484 * Create a new client listener on the given export @exp, using the
1485 * given channel @sioc. Begin servicing it in a coroutine. When the
1486 * connection closes, call @close_fn with an indication of whether the
1487 * client completed negotiation.
1489 void nbd_client_new(NBDExport *exp,
1490 QIOChannelSocket *sioc,
1491 QCryptoTLSCreds *tlscreds,
1492 const char *tlsaclname,
1493 void (*close_fn)(NBDClient *, bool))
1498 client = g_malloc0(sizeof(NBDClient));
1499 client->refcount = 1;
1501 client->tlscreds = tlscreds;
1503 object_ref(OBJECT(client->tlscreds));
1505 client->tlsaclname = g_strdup(tlsaclname);
1506 client->sioc = sioc;
1507 object_ref(OBJECT(client->sioc));
1508 client->ioc = QIO_CHANNEL(sioc);
1509 object_ref(OBJECT(client->ioc));
1510 client->close_fn = close_fn;
1512 co = qemu_coroutine_create(nbd_co_client_start, client);
1513 qemu_coroutine_enter(co);