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)
44 TRACE("Squashing unexpected error %d to EINVAL", err);
53 /* Definitions for opaque data types */
55 static QTAILQ_HEAD(, NBDExport) exports = QTAILQ_HEAD_INITIALIZER(exports);
57 /* That's all folks */
59 /* Basic flow for negotiation
86 /* Discard length bytes from channel. Return -errno on failure, or
87 * the amount of bytes consumed. */
88 static ssize_t drop_sync(QIOChannel *ioc, size_t size)
90 ssize_t ret, dropped = size;
94 buffer = sizeof(small) < size ? small : g_malloc(MIN(65536, size));
96 ret = read_sync(ioc, buffer, MIN(65536, size));
106 if (buffer != small) {
112 /* Send an option request.
114 * The request is for option @opt, with @data containing @len bytes of
115 * additional payload for the request (@len may be -1 to treat @data as
116 * a C string; and @data may be NULL if @len is 0).
117 * Return 0 if successful, -1 with errp set if it is impossible to
119 static int nbd_send_option_request(QIOChannel *ioc, uint32_t opt,
120 uint32_t len, const char *data,
124 QEMU_BUILD_BUG_ON(sizeof(req) != 16);
127 req.length = len = strlen(data);
129 TRACE("Sending option request %" PRIu32", len %" PRIu32, opt, len);
131 stq_be_p(&req.magic, NBD_OPTS_MAGIC);
132 stl_be_p(&req.option, opt);
133 stl_be_p(&req.length, len);
135 if (write_sync(ioc, &req, sizeof(req)) != sizeof(req)) {
136 error_setg(errp, "Failed to send option request header");
140 if (len && write_sync(ioc, (char *) data, len) != len) {
141 error_setg(errp, "Failed to send option request data");
148 /* Send NBD_OPT_ABORT as a courtesy to let the server know that we are
149 * not going to attempt further negotiation. */
150 static void nbd_send_opt_abort(QIOChannel *ioc)
152 /* Technically, a compliant server is supposed to reply to us; but
153 * older servers disconnected instead. At any rate, we're allowed
154 * to disconnect without waiting for the server reply, so we don't
155 * even care if the request makes it to the server, let alone
156 * waiting around for whether the server replies. */
157 nbd_send_option_request(ioc, NBD_OPT_ABORT, 0, NULL, NULL);
161 /* Receive the header of an option reply, which should match the given
162 * opt. Read through the length field, but NOT the length bytes of
163 * payload. Return 0 if successful, -1 with errp set if it is
164 * impossible to continue. */
165 static int nbd_receive_option_reply(QIOChannel *ioc, uint32_t opt,
166 nbd_opt_reply *reply, Error **errp)
168 QEMU_BUILD_BUG_ON(sizeof(*reply) != 20);
169 if (read_sync(ioc, reply, sizeof(*reply)) != sizeof(*reply)) {
170 error_setg(errp, "failed to read option reply");
171 nbd_send_opt_abort(ioc);
174 be64_to_cpus(&reply->magic);
175 be32_to_cpus(&reply->option);
176 be32_to_cpus(&reply->type);
177 be32_to_cpus(&reply->length);
179 TRACE("Received option reply %" PRIx32", type %" PRIx32", len %" PRIu32,
180 reply->option, reply->type, reply->length);
182 if (reply->magic != NBD_REP_MAGIC) {
183 error_setg(errp, "Unexpected option reply magic");
184 nbd_send_opt_abort(ioc);
187 if (reply->option != opt) {
188 error_setg(errp, "Unexpected option type %x expected %x",
190 nbd_send_opt_abort(ioc);
196 /* If reply represents success, return 1 without further action.
197 * If reply represents an error, consume the optional payload of
198 * the packet on ioc. Then return 0 for unsupported (so the client
199 * can fall back to other approaches), or -1 with errp set for other
202 static int nbd_handle_reply_err(QIOChannel *ioc, nbd_opt_reply *reply,
208 if (!(reply->type & (1 << 31))) {
213 if (reply->length > NBD_MAX_BUFFER_SIZE) {
214 error_setg(errp, "server's error message is too long");
217 msg = g_malloc(reply->length + 1);
218 if (read_sync(ioc, msg, reply->length) != reply->length) {
219 error_setg(errp, "failed to read option error message");
222 msg[reply->length] = '\0';
225 switch (reply->type) {
226 case NBD_REP_ERR_UNSUP:
227 TRACE("server doesn't understand request %" PRIx32
228 ", attempting fallback", reply->option);
232 case NBD_REP_ERR_POLICY:
233 error_setg(errp, "Denied by server for option %" PRIx32,
237 case NBD_REP_ERR_INVALID:
238 error_setg(errp, "Invalid data length for option %" PRIx32,
242 case NBD_REP_ERR_TLS_REQD:
243 error_setg(errp, "TLS negotiation required before option %" PRIx32,
248 error_setg(errp, "Unknown error code when asking for option %" PRIx32,
254 error_append_hint(errp, "%s\n", msg);
260 nbd_send_opt_abort(ioc);
265 /* Process another portion of the NBD_OPT_LIST reply. Set *@match if
266 * the current reply matches @want or if the server does not support
267 * NBD_OPT_LIST, otherwise leave @match alone. Return 0 if iteration
268 * is complete, positive if more replies are expected, or negative
269 * with @errp set if an unrecoverable error occurred. */
270 static int nbd_receive_list(QIOChannel *ioc, const char *want, bool *match,
276 char name[NBD_MAX_NAME_SIZE + 1];
279 if (nbd_receive_option_reply(ioc, NBD_OPT_LIST, &reply, errp) < 0) {
282 error = nbd_handle_reply_err(ioc, &reply, errp);
284 /* The server did not support NBD_OPT_LIST, so set *match on
285 * the assumption that any name will be accepted. */
291 if (reply.type == NBD_REP_ACK) {
293 error_setg(errp, "length too long for option end");
294 nbd_send_opt_abort(ioc);
298 } else if (reply.type != NBD_REP_SERVER) {
299 error_setg(errp, "Unexpected reply type %" PRIx32 " expected %x",
300 reply.type, NBD_REP_SERVER);
301 nbd_send_opt_abort(ioc);
305 if (len < sizeof(namelen) || len > NBD_MAX_BUFFER_SIZE) {
306 error_setg(errp, "incorrect option length %" PRIu32, len);
307 nbd_send_opt_abort(ioc);
310 if (read_sync(ioc, &namelen, sizeof(namelen)) != sizeof(namelen)) {
311 error_setg(errp, "failed to read option name length");
312 nbd_send_opt_abort(ioc);
315 namelen = be32_to_cpu(namelen);
316 len -= sizeof(namelen);
318 error_setg(errp, "incorrect option name length");
319 nbd_send_opt_abort(ioc);
322 if (namelen != strlen(want)) {
323 if (drop_sync(ioc, len) != len) {
324 error_setg(errp, "failed to skip export name with wrong length");
325 nbd_send_opt_abort(ioc);
331 assert(namelen < sizeof(name));
332 if (read_sync(ioc, name, namelen) != namelen) {
333 error_setg(errp, "failed to read export name");
334 nbd_send_opt_abort(ioc);
337 name[namelen] = '\0';
339 if (drop_sync(ioc, len) != len) {
340 error_setg(errp, "failed to read export description");
341 nbd_send_opt_abort(ioc);
344 if (!strcmp(name, want)) {
351 /* Return -1 on failure, 0 if wantname is an available export. */
352 static int nbd_receive_query_exports(QIOChannel *ioc,
353 const char *wantname,
356 bool foundExport = false;
358 TRACE("Querying export list for '%s'", wantname);
359 if (nbd_send_option_request(ioc, NBD_OPT_LIST, 0, NULL, errp) < 0) {
363 TRACE("Reading available export names");
365 int ret = nbd_receive_list(ioc, wantname, &foundExport, errp);
368 /* Server gave unexpected reply */
370 } else if (ret == 0) {
371 /* Done iterating. */
373 error_setg(errp, "No export with name '%s' available",
375 nbd_send_opt_abort(ioc);
378 TRACE("Found desired export name '%s'", wantname);
384 static QIOChannel *nbd_receive_starttls(QIOChannel *ioc,
385 QCryptoTLSCreds *tlscreds,
386 const char *hostname, Error **errp)
390 struct NBDTLSHandshakeData data = { 0 };
392 TRACE("Requesting TLS from server");
393 if (nbd_send_option_request(ioc, NBD_OPT_STARTTLS, 0, NULL, errp) < 0) {
397 TRACE("Getting TLS reply from server");
398 if (nbd_receive_option_reply(ioc, NBD_OPT_STARTTLS, &reply, errp) < 0) {
402 if (reply.type != NBD_REP_ACK) {
403 error_setg(errp, "Server rejected request to start TLS %" PRIx32,
405 nbd_send_opt_abort(ioc);
409 if (reply.length != 0) {
410 error_setg(errp, "Start TLS response was not zero %" PRIu32,
412 nbd_send_opt_abort(ioc);
416 TRACE("TLS request approved, setting up TLS");
417 tioc = qio_channel_tls_new_client(ioc, tlscreds, hostname, errp);
421 qio_channel_set_name(QIO_CHANNEL(tioc), "nbd-client-tls");
422 data.loop = g_main_loop_new(g_main_context_default(), FALSE);
423 TRACE("Starting TLS handshake");
424 qio_channel_tls_handshake(tioc,
429 if (!data.complete) {
430 g_main_loop_run(data.loop);
432 g_main_loop_unref(data.loop);
434 error_propagate(errp, data.error);
435 object_unref(OBJECT(tioc));
439 return QIO_CHANNEL(tioc);
443 int nbd_receive_negotiate(QIOChannel *ioc, const char *name, uint16_t *flags,
444 QCryptoTLSCreds *tlscreds, const char *hostname,
446 off_t *size, Error **errp)
453 TRACE("Receiving negotiation tlscreds=%p hostname=%s.",
454 tlscreds, hostname ? hostname : "<null>");
461 if (tlscreds && !outioc) {
462 error_setg(errp, "Output I/O channel required for TLS");
466 if (read_sync(ioc, buf, 8) != 8) {
467 error_setg(errp, "Failed to read data");
472 if (strlen(buf) == 0) {
473 error_setg(errp, "Server connection closed unexpectedly");
477 TRACE("Magic is %c%c%c%c%c%c%c%c",
478 qemu_isprint(buf[0]) ? buf[0] : '.',
479 qemu_isprint(buf[1]) ? buf[1] : '.',
480 qemu_isprint(buf[2]) ? buf[2] : '.',
481 qemu_isprint(buf[3]) ? buf[3] : '.',
482 qemu_isprint(buf[4]) ? buf[4] : '.',
483 qemu_isprint(buf[5]) ? buf[5] : '.',
484 qemu_isprint(buf[6]) ? buf[6] : '.',
485 qemu_isprint(buf[7]) ? buf[7] : '.');
487 if (memcmp(buf, "NBDMAGIC", 8) != 0) {
488 error_setg(errp, "Invalid magic received");
492 if (read_sync(ioc, &magic, sizeof(magic)) != sizeof(magic)) {
493 error_setg(errp, "Failed to read magic");
496 magic = be64_to_cpu(magic);
497 TRACE("Magic is 0x%" PRIx64, magic);
499 if (magic == NBD_OPTS_MAGIC) {
500 uint32_t clientflags = 0;
501 uint16_t globalflags;
502 bool fixedNewStyle = false;
504 if (read_sync(ioc, &globalflags, sizeof(globalflags)) !=
505 sizeof(globalflags)) {
506 error_setg(errp, "Failed to read server flags");
509 globalflags = be16_to_cpu(globalflags);
510 TRACE("Global flags are %" PRIx32, globalflags);
511 if (globalflags & NBD_FLAG_FIXED_NEWSTYLE) {
512 fixedNewStyle = true;
513 TRACE("Server supports fixed new style");
514 clientflags |= NBD_FLAG_C_FIXED_NEWSTYLE;
516 if (globalflags & NBD_FLAG_NO_ZEROES) {
518 TRACE("Server supports no zeroes");
519 clientflags |= NBD_FLAG_C_NO_ZEROES;
521 /* client requested flags */
522 clientflags = cpu_to_be32(clientflags);
523 if (write_sync(ioc, &clientflags, sizeof(clientflags)) !=
524 sizeof(clientflags)) {
525 error_setg(errp, "Failed to send clientflags field");
530 *outioc = nbd_receive_starttls(ioc, tlscreds, hostname, errp);
536 error_setg(errp, "Server does not support STARTTLS");
541 TRACE("Using default NBD export name \"\"");
545 /* Check our desired export is present in the
546 * server export list. Since NBD_OPT_EXPORT_NAME
547 * cannot return an error message, running this
548 * query gives us good error reporting if the
549 * server required TLS
551 if (nbd_receive_query_exports(ioc, name, errp) < 0) {
555 /* write the export name request */
556 if (nbd_send_option_request(ioc, NBD_OPT_EXPORT_NAME, -1, name,
561 /* Read the response */
562 if (read_sync(ioc, &s, sizeof(s)) != sizeof(s)) {
563 error_setg(errp, "Failed to read export length");
566 *size = be64_to_cpu(s);
568 if (read_sync(ioc, flags, sizeof(*flags)) != sizeof(*flags)) {
569 error_setg(errp, "Failed to read export flags");
573 } else if (magic == NBD_CLIENT_MAGIC) {
577 error_setg(errp, "Server does not support export names");
581 error_setg(errp, "Server does not support STARTTLS");
585 if (read_sync(ioc, &s, sizeof(s)) != sizeof(s)) {
586 error_setg(errp, "Failed to read export length");
589 *size = be64_to_cpu(s);
590 TRACE("Size is %" PRIu64, *size);
592 if (read_sync(ioc, &oldflags, sizeof(oldflags)) != sizeof(oldflags)) {
593 error_setg(errp, "Failed to read export flags");
596 be32_to_cpus(&oldflags);
597 if (oldflags & ~0xffff) {
598 error_setg(errp, "Unexpected export flags %0x" PRIx32, oldflags);
603 error_setg(errp, "Bad magic received");
607 TRACE("Size is %" PRIu64 ", export flags %" PRIx16, *size, *flags);
608 if (zeroes && drop_sync(ioc, 124) != 124) {
609 error_setg(errp, "Failed to read reserved block");
619 int nbd_init(int fd, QIOChannelSocket *sioc, uint16_t flags, off_t size)
621 unsigned long sectors = size / BDRV_SECTOR_SIZE;
622 if (size / BDRV_SECTOR_SIZE != sectors) {
623 LOG("Export size %lld too large for 32-bit kernel", (long long) size);
627 TRACE("Setting NBD socket");
629 if (ioctl(fd, NBD_SET_SOCK, (unsigned long) sioc->fd) < 0) {
631 LOG("Failed to set NBD socket");
635 TRACE("Setting block size to %lu", (unsigned long)BDRV_SECTOR_SIZE);
637 if (ioctl(fd, NBD_SET_BLKSIZE, (unsigned long)BDRV_SECTOR_SIZE) < 0) {
639 LOG("Failed setting NBD block size");
643 TRACE("Setting size to %lu block(s)", sectors);
644 if (size % BDRV_SECTOR_SIZE) {
645 TRACE("Ignoring trailing %d bytes of export",
646 (int) (size % BDRV_SECTOR_SIZE));
649 if (ioctl(fd, NBD_SET_SIZE_BLOCKS, sectors) < 0) {
651 LOG("Failed setting size (in blocks)");
655 if (ioctl(fd, NBD_SET_FLAGS, (unsigned long) flags) < 0) {
656 if (errno == ENOTTY) {
657 int read_only = (flags & NBD_FLAG_READ_ONLY) != 0;
658 TRACE("Setting readonly attribute");
660 if (ioctl(fd, BLKROSET, (unsigned long) &read_only) < 0) {
662 LOG("Failed setting read-only attribute");
667 LOG("Failed setting flags");
672 TRACE("Negotiation ended");
677 int nbd_client(int fd)
682 TRACE("Doing NBD loop");
684 ret = ioctl(fd, NBD_DO_IT);
685 if (ret < 0 && errno == EPIPE) {
686 /* NBD_DO_IT normally returns EPIPE when someone has disconnected
687 * the socket via NBD_DISCONNECT. We do not want to return 1 in
694 TRACE("NBD loop returned %d: %s", ret, strerror(serrno));
696 TRACE("Clearing NBD queue");
697 ioctl(fd, NBD_CLEAR_QUE);
699 TRACE("Clearing NBD socket");
700 ioctl(fd, NBD_CLEAR_SOCK);
706 int nbd_disconnect(int fd)
708 ioctl(fd, NBD_CLEAR_QUE);
709 ioctl(fd, NBD_DISCONNECT);
710 ioctl(fd, NBD_CLEAR_SOCK);
715 int nbd_init(int fd, QIOChannelSocket *ioc, uint16_t flags, off_t size)
720 int nbd_client(int fd)
724 int nbd_disconnect(int fd)
730 ssize_t nbd_send_request(QIOChannel *ioc, NBDRequest *request)
732 uint8_t buf[NBD_REQUEST_SIZE];
735 TRACE("Sending request to server: "
736 "{ .from = %" PRIu64", .len = %" PRIu32 ", .handle = %" PRIu64
737 ", .flags = %" PRIx16 ", .type = %" PRIu16 " }",
738 request->from, request->len, request->handle,
739 request->flags, request->type);
741 stl_be_p(buf, NBD_REQUEST_MAGIC);
742 stw_be_p(buf + 4, request->flags);
743 stw_be_p(buf + 6, request->type);
744 stq_be_p(buf + 8, request->handle);
745 stq_be_p(buf + 16, request->from);
746 stl_be_p(buf + 24, request->len);
748 ret = write_sync(ioc, buf, sizeof(buf));
753 if (ret != sizeof(buf)) {
754 LOG("writing to socket failed");
760 ssize_t nbd_receive_reply(QIOChannel *ioc, NBDReply *reply)
762 uint8_t buf[NBD_REPLY_SIZE];
766 ret = read_sync(ioc, buf, sizeof(buf));
771 if (ret != sizeof(buf)) {
777 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
778 [ 4 .. 7] error (0 == no error)
782 magic = ldl_be_p(buf);
783 reply->error = ldl_be_p(buf + 4);
784 reply->handle = ldq_be_p(buf + 8);
786 reply->error = nbd_errno_to_system_errno(reply->error);
788 TRACE("Got reply: { magic = 0x%" PRIx32 ", .error = % " PRId32
789 ", handle = %" PRIu64" }",
790 magic, reply->error, reply->handle);
792 if (magic != NBD_REPLY_MAGIC) {
793 LOG("invalid magic (got 0x%" PRIx32 ")", magic);