2 * Copyright (C) 2016 Red Hat, Inc.
5 * Network Block Device Client 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"
22 #include "nbd-internal.h"
24 static int nbd_errno_to_system_errno(int err)
47 TRACE("Squashing unexpected error %d to EINVAL", err);
56 /* Definitions for opaque data types */
58 static QTAILQ_HEAD(, NBDExport) exports = QTAILQ_HEAD_INITIALIZER(exports);
60 /* That's all folks */
62 /* Basic flow for negotiation
89 /* Discard length bytes from channel. Return -errno on failure, or
90 * the amount of bytes consumed. */
91 static ssize_t drop_sync(QIOChannel *ioc, size_t size)
97 buffer = sizeof(small) < size ? small : g_malloc(MIN(65536, size));
99 ssize_t count = read_sync(ioc, buffer, MIN(65536, size));
104 assert(count <= size);
110 if (buffer != small) {
116 /* Send an option request.
118 * The request is for option @opt, with @data containing @len bytes of
119 * additional payload for the request (@len may be -1 to treat @data as
120 * a C string; and @data may be NULL if @len is 0).
121 * Return 0 if successful, -1 with errp set if it is impossible to
123 static int nbd_send_option_request(QIOChannel *ioc, uint32_t opt,
124 uint32_t len, const char *data,
128 QEMU_BUILD_BUG_ON(sizeof(req) != 16);
131 req.length = len = strlen(data);
133 TRACE("Sending option request %" PRIu32", len %" PRIu32, opt, len);
135 stq_be_p(&req.magic, NBD_OPTS_MAGIC);
136 stl_be_p(&req.option, opt);
137 stl_be_p(&req.length, len);
139 if (write_sync(ioc, &req, sizeof(req)) != sizeof(req)) {
140 error_setg(errp, "Failed to send option request header");
144 if (len && write_sync(ioc, (char *) data, len) != len) {
145 error_setg(errp, "Failed to send option request data");
152 /* Send NBD_OPT_ABORT as a courtesy to let the server know that we are
153 * not going to attempt further negotiation. */
154 static void nbd_send_opt_abort(QIOChannel *ioc)
156 /* Technically, a compliant server is supposed to reply to us; but
157 * older servers disconnected instead. At any rate, we're allowed
158 * to disconnect without waiting for the server reply, so we don't
159 * even care if the request makes it to the server, let alone
160 * waiting around for whether the server replies. */
161 nbd_send_option_request(ioc, NBD_OPT_ABORT, 0, NULL, NULL);
165 /* Receive the header of an option reply, which should match the given
166 * opt. Read through the length field, but NOT the length bytes of
167 * payload. Return 0 if successful, -1 with errp set if it is
168 * impossible to continue. */
169 static int nbd_receive_option_reply(QIOChannel *ioc, uint32_t opt,
170 nbd_opt_reply *reply, Error **errp)
172 QEMU_BUILD_BUG_ON(sizeof(*reply) != 20);
173 if (read_sync(ioc, reply, sizeof(*reply)) != sizeof(*reply)) {
174 error_setg(errp, "failed to read option reply");
175 nbd_send_opt_abort(ioc);
178 be64_to_cpus(&reply->magic);
179 be32_to_cpus(&reply->option);
180 be32_to_cpus(&reply->type);
181 be32_to_cpus(&reply->length);
183 TRACE("Received option reply %" PRIx32", type %" PRIx32", len %" PRIu32,
184 reply->option, reply->type, reply->length);
186 if (reply->magic != NBD_REP_MAGIC) {
187 error_setg(errp, "Unexpected option reply magic");
188 nbd_send_opt_abort(ioc);
191 if (reply->option != opt) {
192 error_setg(errp, "Unexpected option type %x expected %x",
194 nbd_send_opt_abort(ioc);
200 /* If reply represents success, return 1 without further action.
201 * If reply represents an error, consume the optional payload of
202 * the packet on ioc. Then return 0 for unsupported (so the client
203 * can fall back to other approaches), or -1 with errp set for other
206 static int nbd_handle_reply_err(QIOChannel *ioc, nbd_opt_reply *reply,
212 if (!(reply->type & (1 << 31))) {
217 if (reply->length > NBD_MAX_BUFFER_SIZE) {
218 error_setg(errp, "server's error message is too long");
221 msg = g_malloc(reply->length + 1);
222 if (read_sync(ioc, msg, reply->length) != reply->length) {
223 error_setg(errp, "failed to read option error message");
226 msg[reply->length] = '\0';
229 switch (reply->type) {
230 case NBD_REP_ERR_UNSUP:
231 TRACE("server doesn't understand request %" PRIx32
232 ", attempting fallback", reply->option);
236 case NBD_REP_ERR_POLICY:
237 error_setg(errp, "Denied by server for option %" PRIx32,
241 case NBD_REP_ERR_INVALID:
242 error_setg(errp, "Invalid data length for option %" PRIx32,
246 case NBD_REP_ERR_PLATFORM:
247 error_setg(errp, "Server lacks support for option %" PRIx32,
251 case NBD_REP_ERR_TLS_REQD:
252 error_setg(errp, "TLS negotiation required before option %" PRIx32,
256 case NBD_REP_ERR_SHUTDOWN:
257 error_setg(errp, "Server shutting down before option %" PRIx32,
262 error_setg(errp, "Unknown error code when asking for option %" PRIx32,
268 error_append_hint(errp, "%s\n", msg);
274 nbd_send_opt_abort(ioc);
279 /* Process another portion of the NBD_OPT_LIST reply. Set *@match if
280 * the current reply matches @want or if the server does not support
281 * NBD_OPT_LIST, otherwise leave @match alone. Return 0 if iteration
282 * is complete, positive if more replies are expected, or negative
283 * with @errp set if an unrecoverable error occurred. */
284 static int nbd_receive_list(QIOChannel *ioc, const char *want, bool *match,
290 char name[NBD_MAX_NAME_SIZE + 1];
293 if (nbd_receive_option_reply(ioc, NBD_OPT_LIST, &reply, errp) < 0) {
296 error = nbd_handle_reply_err(ioc, &reply, errp);
298 /* The server did not support NBD_OPT_LIST, so set *match on
299 * the assumption that any name will be accepted. */
305 if (reply.type == NBD_REP_ACK) {
307 error_setg(errp, "length too long for option end");
308 nbd_send_opt_abort(ioc);
312 } else if (reply.type != NBD_REP_SERVER) {
313 error_setg(errp, "Unexpected reply type %" PRIx32 " expected %x",
314 reply.type, NBD_REP_SERVER);
315 nbd_send_opt_abort(ioc);
319 if (len < sizeof(namelen) || len > NBD_MAX_BUFFER_SIZE) {
320 error_setg(errp, "incorrect option length %" PRIu32, len);
321 nbd_send_opt_abort(ioc);
324 if (read_sync(ioc, &namelen, sizeof(namelen)) != sizeof(namelen)) {
325 error_setg(errp, "failed to read option name length");
326 nbd_send_opt_abort(ioc);
329 namelen = be32_to_cpu(namelen);
330 len -= sizeof(namelen);
332 error_setg(errp, "incorrect option name length");
333 nbd_send_opt_abort(ioc);
336 if (namelen != strlen(want)) {
337 if (drop_sync(ioc, len) != len) {
338 error_setg(errp, "failed to skip export name with wrong length");
339 nbd_send_opt_abort(ioc);
345 assert(namelen < sizeof(name));
346 if (read_sync(ioc, name, namelen) != namelen) {
347 error_setg(errp, "failed to read export name");
348 nbd_send_opt_abort(ioc);
351 name[namelen] = '\0';
353 if (drop_sync(ioc, len) != len) {
354 error_setg(errp, "failed to read export description");
355 nbd_send_opt_abort(ioc);
358 if (!strcmp(name, want)) {
365 /* Return -1 on failure, 0 if wantname is an available export. */
366 static int nbd_receive_query_exports(QIOChannel *ioc,
367 const char *wantname,
370 bool foundExport = false;
372 TRACE("Querying export list for '%s'", wantname);
373 if (nbd_send_option_request(ioc, NBD_OPT_LIST, 0, NULL, errp) < 0) {
377 TRACE("Reading available export names");
379 int ret = nbd_receive_list(ioc, wantname, &foundExport, errp);
382 /* Server gave unexpected reply */
384 } else if (ret == 0) {
385 /* Done iterating. */
387 error_setg(errp, "No export with name '%s' available",
389 nbd_send_opt_abort(ioc);
392 TRACE("Found desired export name '%s'", wantname);
398 static QIOChannel *nbd_receive_starttls(QIOChannel *ioc,
399 QCryptoTLSCreds *tlscreds,
400 const char *hostname, Error **errp)
404 struct NBDTLSHandshakeData data = { 0 };
406 TRACE("Requesting TLS from server");
407 if (nbd_send_option_request(ioc, NBD_OPT_STARTTLS, 0, NULL, errp) < 0) {
411 TRACE("Getting TLS reply from server");
412 if (nbd_receive_option_reply(ioc, NBD_OPT_STARTTLS, &reply, errp) < 0) {
416 if (reply.type != NBD_REP_ACK) {
417 error_setg(errp, "Server rejected request to start TLS %" PRIx32,
419 nbd_send_opt_abort(ioc);
423 if (reply.length != 0) {
424 error_setg(errp, "Start TLS response was not zero %" PRIu32,
426 nbd_send_opt_abort(ioc);
430 TRACE("TLS request approved, setting up TLS");
431 tioc = qio_channel_tls_new_client(ioc, tlscreds, hostname, errp);
435 qio_channel_set_name(QIO_CHANNEL(tioc), "nbd-client-tls");
436 data.loop = g_main_loop_new(g_main_context_default(), FALSE);
437 TRACE("Starting TLS handshake");
438 qio_channel_tls_handshake(tioc,
443 if (!data.complete) {
444 g_main_loop_run(data.loop);
446 g_main_loop_unref(data.loop);
448 error_propagate(errp, data.error);
449 object_unref(OBJECT(tioc));
453 return QIO_CHANNEL(tioc);
457 int nbd_receive_negotiate(QIOChannel *ioc, const char *name, uint16_t *flags,
458 QCryptoTLSCreds *tlscreds, const char *hostname,
460 off_t *size, Error **errp)
467 TRACE("Receiving negotiation tlscreds=%p hostname=%s.",
468 tlscreds, hostname ? hostname : "<null>");
475 if (tlscreds && !outioc) {
476 error_setg(errp, "Output I/O channel required for TLS");
480 if (read_sync(ioc, buf, 8) != 8) {
481 error_setg(errp, "Failed to read data");
486 if (strlen(buf) == 0) {
487 error_setg(errp, "Server connection closed unexpectedly");
491 TRACE("Magic is %c%c%c%c%c%c%c%c",
492 qemu_isprint(buf[0]) ? buf[0] : '.',
493 qemu_isprint(buf[1]) ? buf[1] : '.',
494 qemu_isprint(buf[2]) ? buf[2] : '.',
495 qemu_isprint(buf[3]) ? buf[3] : '.',
496 qemu_isprint(buf[4]) ? buf[4] : '.',
497 qemu_isprint(buf[5]) ? buf[5] : '.',
498 qemu_isprint(buf[6]) ? buf[6] : '.',
499 qemu_isprint(buf[7]) ? buf[7] : '.');
501 if (memcmp(buf, "NBDMAGIC", 8) != 0) {
502 error_setg(errp, "Invalid magic received");
506 if (read_sync(ioc, &magic, sizeof(magic)) != sizeof(magic)) {
507 error_setg(errp, "Failed to read magic");
510 magic = be64_to_cpu(magic);
511 TRACE("Magic is 0x%" PRIx64, magic);
513 if (magic == NBD_OPTS_MAGIC) {
514 uint32_t clientflags = 0;
515 uint16_t globalflags;
516 bool fixedNewStyle = false;
518 if (read_sync(ioc, &globalflags, sizeof(globalflags)) !=
519 sizeof(globalflags)) {
520 error_setg(errp, "Failed to read server flags");
523 globalflags = be16_to_cpu(globalflags);
524 TRACE("Global flags are %" PRIx32, globalflags);
525 if (globalflags & NBD_FLAG_FIXED_NEWSTYLE) {
526 fixedNewStyle = true;
527 TRACE("Server supports fixed new style");
528 clientflags |= NBD_FLAG_C_FIXED_NEWSTYLE;
530 if (globalflags & NBD_FLAG_NO_ZEROES) {
532 TRACE("Server supports no zeroes");
533 clientflags |= NBD_FLAG_C_NO_ZEROES;
535 /* client requested flags */
536 clientflags = cpu_to_be32(clientflags);
537 if (write_sync(ioc, &clientflags, sizeof(clientflags)) !=
538 sizeof(clientflags)) {
539 error_setg(errp, "Failed to send clientflags field");
544 *outioc = nbd_receive_starttls(ioc, tlscreds, hostname, errp);
550 error_setg(errp, "Server does not support STARTTLS");
555 TRACE("Using default NBD export name \"\"");
559 /* Check our desired export is present in the
560 * server export list. Since NBD_OPT_EXPORT_NAME
561 * cannot return an error message, running this
562 * query gives us good error reporting if the
563 * server required TLS
565 if (nbd_receive_query_exports(ioc, name, errp) < 0) {
569 /* write the export name request */
570 if (nbd_send_option_request(ioc, NBD_OPT_EXPORT_NAME, -1, name,
575 /* Read the response */
576 if (read_sync(ioc, &s, sizeof(s)) != sizeof(s)) {
577 error_setg(errp, "Failed to read export length");
580 *size = be64_to_cpu(s);
582 if (read_sync(ioc, flags, sizeof(*flags)) != sizeof(*flags)) {
583 error_setg(errp, "Failed to read export flags");
587 } else if (magic == NBD_CLIENT_MAGIC) {
591 error_setg(errp, "Server does not support export names");
595 error_setg(errp, "Server does not support STARTTLS");
599 if (read_sync(ioc, &s, sizeof(s)) != sizeof(s)) {
600 error_setg(errp, "Failed to read export length");
603 *size = be64_to_cpu(s);
604 TRACE("Size is %" PRIu64, *size);
606 if (read_sync(ioc, &oldflags, sizeof(oldflags)) != sizeof(oldflags)) {
607 error_setg(errp, "Failed to read export flags");
610 be32_to_cpus(&oldflags);
611 if (oldflags & ~0xffff) {
612 error_setg(errp, "Unexpected export flags %0x" PRIx32, oldflags);
617 error_setg(errp, "Bad magic received");
621 TRACE("Size is %" PRIu64 ", export flags %" PRIx16, *size, *flags);
622 if (zeroes && drop_sync(ioc, 124) != 124) {
623 error_setg(errp, "Failed to read reserved block");
633 int nbd_init(int fd, QIOChannelSocket *sioc, uint16_t flags, off_t size)
635 unsigned long sectors = size / BDRV_SECTOR_SIZE;
636 if (size / BDRV_SECTOR_SIZE != sectors) {
637 LOG("Export size %lld too large for 32-bit kernel", (long long) size);
641 TRACE("Setting NBD socket");
643 if (ioctl(fd, NBD_SET_SOCK, (unsigned long) sioc->fd) < 0) {
645 LOG("Failed to set NBD socket");
649 TRACE("Setting block size to %lu", (unsigned long)BDRV_SECTOR_SIZE);
651 if (ioctl(fd, NBD_SET_BLKSIZE, (unsigned long)BDRV_SECTOR_SIZE) < 0) {
653 LOG("Failed setting NBD block size");
657 TRACE("Setting size to %lu block(s)", sectors);
658 if (size % BDRV_SECTOR_SIZE) {
659 TRACE("Ignoring trailing %d bytes of export",
660 (int) (size % BDRV_SECTOR_SIZE));
663 if (ioctl(fd, NBD_SET_SIZE_BLOCKS, sectors) < 0) {
665 LOG("Failed setting size (in blocks)");
669 if (ioctl(fd, NBD_SET_FLAGS, (unsigned long) flags) < 0) {
670 if (errno == ENOTTY) {
671 int read_only = (flags & NBD_FLAG_READ_ONLY) != 0;
672 TRACE("Setting readonly attribute");
674 if (ioctl(fd, BLKROSET, (unsigned long) &read_only) < 0) {
676 LOG("Failed setting read-only attribute");
681 LOG("Failed setting flags");
686 TRACE("Negotiation ended");
691 int nbd_client(int fd)
696 TRACE("Doing NBD loop");
698 ret = ioctl(fd, NBD_DO_IT);
699 if (ret < 0 && errno == EPIPE) {
700 /* NBD_DO_IT normally returns EPIPE when someone has disconnected
701 * the socket via NBD_DISCONNECT. We do not want to return 1 in
708 TRACE("NBD loop returned %d: %s", ret, strerror(serrno));
710 TRACE("Clearing NBD queue");
711 ioctl(fd, NBD_CLEAR_QUE);
713 TRACE("Clearing NBD socket");
714 ioctl(fd, NBD_CLEAR_SOCK);
720 int nbd_disconnect(int fd)
722 ioctl(fd, NBD_CLEAR_QUE);
723 ioctl(fd, NBD_DISCONNECT);
724 ioctl(fd, NBD_CLEAR_SOCK);
729 int nbd_init(int fd, QIOChannelSocket *ioc, uint16_t flags, off_t size)
734 int nbd_client(int fd)
738 int nbd_disconnect(int fd)
744 ssize_t nbd_send_request(QIOChannel *ioc, NBDRequest *request)
746 uint8_t buf[NBD_REQUEST_SIZE];
749 TRACE("Sending request to server: "
750 "{ .from = %" PRIu64", .len = %" PRIu32 ", .handle = %" PRIu64
751 ", .flags = %" PRIx16 ", .type = %" PRIu16 " }",
752 request->from, request->len, request->handle,
753 request->flags, request->type);
755 stl_be_p(buf, NBD_REQUEST_MAGIC);
756 stw_be_p(buf + 4, request->flags);
757 stw_be_p(buf + 6, request->type);
758 stq_be_p(buf + 8, request->handle);
759 stq_be_p(buf + 16, request->from);
760 stl_be_p(buf + 24, request->len);
762 ret = write_sync(ioc, buf, sizeof(buf));
767 if (ret != sizeof(buf)) {
768 LOG("writing to socket failed");
774 ssize_t nbd_receive_reply(QIOChannel *ioc, NBDReply *reply)
776 uint8_t buf[NBD_REPLY_SIZE];
780 ret = read_sync(ioc, buf, sizeof(buf));
785 if (ret != sizeof(buf)) {
791 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
792 [ 4 .. 7] error (0 == no error)
796 magic = ldl_be_p(buf);
797 reply->error = ldl_be_p(buf + 4);
798 reply->handle = ldq_be_p(buf + 8);
800 reply->error = nbd_errno_to_system_errno(reply->error);
802 if (reply->error == ESHUTDOWN) {
803 /* This works even on mingw which lacks a native ESHUTDOWN */
804 LOG("server shutting down");
807 TRACE("Got reply: { magic = 0x%" PRIx32 ", .error = % " PRId32
808 ", handle = %" PRIu64" }",
809 magic, reply->error, reply->handle);
811 if (magic != NBD_REPLY_MAGIC) {
812 LOG("invalid magic (got 0x%" PRIx32 ")", magic);