6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; under version 2 of the License.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include "block_int.h"
23 #include "qemu-coroutine.h"
28 #include <sys/ioctl.h>
30 #if defined(__sun__) || defined(__HAIKU__)
31 #include <sys/ioccom.h>
40 #include "qemu_socket.h"
41 #include "qemu-queue.h"
46 #define TRACE(msg, ...) do { \
47 LOG(msg, ## __VA_ARGS__); \
50 #define TRACE(msg, ...) \
54 #define LOG(msg, ...) do { \
55 fprintf(stderr, "%s:%s():L%d: " msg "\n", \
56 __FILE__, __FUNCTION__, __LINE__, ## __VA_ARGS__); \
59 /* This is all part of the "official" NBD API */
61 #define NBD_REPLY_SIZE (4 + 4 + 8)
62 #define NBD_REQUEST_MAGIC 0x25609513
63 #define NBD_REPLY_MAGIC 0x67446698
65 #define NBD_SET_SOCK _IO(0xab, 0)
66 #define NBD_SET_BLKSIZE _IO(0xab, 1)
67 #define NBD_SET_SIZE _IO(0xab, 2)
68 #define NBD_DO_IT _IO(0xab, 3)
69 #define NBD_CLEAR_SOCK _IO(0xab, 4)
70 #define NBD_CLEAR_QUE _IO(0xab, 5)
71 #define NBD_PRINT_DEBUG _IO(0xab, 6)
72 #define NBD_SET_SIZE_BLOCKS _IO(0xab, 7)
73 #define NBD_DISCONNECT _IO(0xab, 8)
74 #define NBD_SET_TIMEOUT _IO(0xab, 9)
75 #define NBD_SET_FLAGS _IO(0xab, 10)
77 #define NBD_OPT_EXPORT_NAME (1 << 0)
79 /* That's all folks */
81 #define read_sync(fd, buffer, size) nbd_wr_sync(fd, buffer, size, true)
82 #define write_sync(fd, buffer, size) nbd_wr_sync(fd, buffer, size, false)
84 size_t nbd_wr_sync(int fd, void *buffer, size_t size, bool do_read)
88 if (qemu_in_coroutine()) {
90 return qemu_co_recv(fd, buffer, size);
92 return qemu_co_send(fd, buffer, size);
96 while (offset < size) {
100 len = qemu_recv(fd, buffer + offset, size - offset, 0);
102 len = send(fd, buffer + offset, size - offset, 0);
106 errno = socket_error();
108 /* recoverable error */
109 if (len == -1 && (errno == EAGAIN || errno == EINTR)) {
118 /* unrecoverable error */
129 static void combine_addr(char *buf, size_t len, const char* address,
132 /* If the address-part contains a colon, it's an IPv6 IP so needs [] */
133 if (strstr(address, ":")) {
134 snprintf(buf, len, "[%s]:%u", address, port);
136 snprintf(buf, len, "%s:%u", address, port);
140 int tcp_socket_outgoing(const char *address, uint16_t port)
142 char address_and_port[128];
143 combine_addr(address_and_port, 128, address, port);
144 return tcp_socket_outgoing_spec(address_and_port);
147 int tcp_socket_outgoing_spec(const char *address_and_port)
149 return inet_connect(address_and_port, SOCK_STREAM);
152 int tcp_socket_incoming(const char *address, uint16_t port)
154 char address_and_port[128];
155 combine_addr(address_and_port, 128, address, port);
156 return tcp_socket_incoming_spec(address_and_port);
159 int tcp_socket_incoming_spec(const char *address_and_port)
163 return inet_listen(address_and_port, ostr, olen, SOCK_STREAM, 0);
166 int unix_socket_incoming(const char *path)
171 return unix_listen(path, ostr, olen);
174 int unix_socket_outgoing(const char *path)
176 return unix_connect(path);
193 static int nbd_send_negotiate(int csock, off_t size, uint32_t flags)
195 char buf[8 + 8 + 8 + 128];
198 [ 0 .. 7] passwd ("NBDMAGIC")
199 [ 8 .. 15] magic (0x00420281861253)
202 [28 .. 151] reserved (0)
205 TRACE("Beginning negotiation.");
206 memcpy(buf, "NBDMAGIC", 8);
207 cpu_to_be64w((uint64_t*)(buf + 8), 0x00420281861253LL);
208 cpu_to_be64w((uint64_t*)(buf + 16), size);
209 cpu_to_be32w((uint32_t*)(buf + 24),
210 flags | NBD_FLAG_HAS_FLAGS | NBD_FLAG_SEND_TRIM |
211 NBD_FLAG_SEND_FLUSH | NBD_FLAG_SEND_FUA);
212 memset(buf + 28, 0, 124);
214 if (write_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
220 TRACE("Negotiation succeeded.");
225 int nbd_receive_negotiate(int csock, const char *name, uint32_t *flags,
226 off_t *size, size_t *blocksize)
232 TRACE("Receiving negotiation.");
234 if (read_sync(csock, buf, 8) != 8) {
241 if (strlen(buf) == 0) {
242 LOG("server connection closed");
247 TRACE("Magic is %c%c%c%c%c%c%c%c",
248 qemu_isprint(buf[0]) ? buf[0] : '.',
249 qemu_isprint(buf[1]) ? buf[1] : '.',
250 qemu_isprint(buf[2]) ? buf[2] : '.',
251 qemu_isprint(buf[3]) ? buf[3] : '.',
252 qemu_isprint(buf[4]) ? buf[4] : '.',
253 qemu_isprint(buf[5]) ? buf[5] : '.',
254 qemu_isprint(buf[6]) ? buf[6] : '.',
255 qemu_isprint(buf[7]) ? buf[7] : '.');
257 if (memcmp(buf, "NBDMAGIC", 8) != 0) {
258 LOG("Invalid magic received");
263 if (read_sync(csock, &magic, sizeof(magic)) != sizeof(magic)) {
268 magic = be64_to_cpu(magic);
269 TRACE("Magic is 0x%" PRIx64, magic);
272 uint32_t reserved = 0;
276 TRACE("Checking magic (opts_magic)");
277 if (magic != 0x49484156454F5054LL) {
278 LOG("Bad magic received");
282 if (read_sync(csock, &tmp, sizeof(tmp)) != sizeof(tmp)) {
283 LOG("flags read failed");
287 *flags = be16_to_cpu(tmp) << 16;
288 /* reserved for future use */
289 if (write_sync(csock, &reserved, sizeof(reserved)) !=
291 LOG("write failed (reserved)");
295 /* write the export name */
296 magic = cpu_to_be64(magic);
297 if (write_sync(csock, &magic, sizeof(magic)) != sizeof(magic)) {
298 LOG("write failed (magic)");
302 opt = cpu_to_be32(NBD_OPT_EXPORT_NAME);
303 if (write_sync(csock, &opt, sizeof(opt)) != sizeof(opt)) {
304 LOG("write failed (opt)");
308 namesize = cpu_to_be32(strlen(name));
309 if (write_sync(csock, &namesize, sizeof(namesize)) !=
311 LOG("write failed (namesize)");
315 if (write_sync(csock, (char*)name, strlen(name)) != strlen(name)) {
316 LOG("write failed (name)");
321 TRACE("Checking magic (cli_magic)");
323 if (magic != 0x00420281861253LL) {
324 LOG("Bad magic received");
330 if (read_sync(csock, &s, sizeof(s)) != sizeof(s)) {
335 *size = be64_to_cpu(s);
337 TRACE("Size is %" PRIu64, *size);
340 if (read_sync(csock, flags, sizeof(*flags)) != sizeof(*flags)) {
341 LOG("read failed (flags)");
345 *flags = be32_to_cpup(flags);
347 if (read_sync(csock, &tmp, sizeof(tmp)) != sizeof(tmp)) {
348 LOG("read failed (tmp)");
352 *flags |= be32_to_cpu(tmp);
354 if (read_sync(csock, &buf, 124) != 124) {
355 LOG("read failed (buf)");
363 int nbd_init(int fd, int csock, uint32_t flags, off_t size, size_t blocksize)
365 TRACE("Setting NBD socket");
367 if (ioctl(fd, NBD_SET_SOCK, csock) == -1) {
369 LOG("Failed to set NBD socket");
374 TRACE("Setting block size to %lu", (unsigned long)blocksize);
376 if (ioctl(fd, NBD_SET_BLKSIZE, blocksize) == -1) {
378 LOG("Failed setting NBD block size");
383 TRACE("Setting size to %zd block(s)", (size_t)(size / blocksize));
385 if (ioctl(fd, NBD_SET_SIZE_BLOCKS, size / blocksize) == -1) {
387 LOG("Failed setting size (in blocks)");
392 if (flags & NBD_FLAG_READ_ONLY) {
394 TRACE("Setting readonly attribute");
396 if (ioctl(fd, BLKROSET, (unsigned long) &read_only) < 0) {
398 LOG("Failed setting read-only attribute");
404 if (ioctl(fd, NBD_SET_FLAGS, flags) < 0
405 && errno != ENOTTY) {
407 LOG("Failed setting flags");
412 TRACE("Negotiation ended");
417 int nbd_disconnect(int fd)
419 ioctl(fd, NBD_CLEAR_QUE);
420 ioctl(fd, NBD_DISCONNECT);
421 ioctl(fd, NBD_CLEAR_SOCK);
425 int nbd_client(int fd)
430 TRACE("Doing NBD loop");
432 ret = ioctl(fd, NBD_DO_IT);
433 if (ret == -1 && errno == EPIPE) {
434 /* NBD_DO_IT normally returns EPIPE when someone has disconnected
435 * the socket via NBD_DISCONNECT. We do not want to return 1 in
442 TRACE("NBD loop returned %d: %s", ret, strerror(serrno));
444 TRACE("Clearing NBD queue");
445 ioctl(fd, NBD_CLEAR_QUE);
447 TRACE("Clearing NBD socket");
448 ioctl(fd, NBD_CLEAR_SOCK);
454 int nbd_init(int fd, int csock, uint32_t flags, off_t size, size_t blocksize)
460 int nbd_disconnect(int fd)
466 int nbd_client(int fd)
473 ssize_t nbd_send_request(int csock, struct nbd_request *request)
475 uint8_t buf[4 + 4 + 8 + 8 + 4];
477 cpu_to_be32w((uint32_t*)buf, NBD_REQUEST_MAGIC);
478 cpu_to_be32w((uint32_t*)(buf + 4), request->type);
479 cpu_to_be64w((uint64_t*)(buf + 8), request->handle);
480 cpu_to_be64w((uint64_t*)(buf + 16), request->from);
481 cpu_to_be32w((uint32_t*)(buf + 24), request->len);
483 TRACE("Sending request to client: "
484 "{ .from = %" PRIu64", .len = %u, .handle = %" PRIu64", .type=%i}",
485 request->from, request->len, request->handle, request->type);
487 if (write_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
488 LOG("writing to socket failed");
495 static ssize_t nbd_receive_request(int csock, struct nbd_request *request)
497 uint8_t buf[4 + 4 + 8 + 8 + 4];
500 if (read_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
507 [ 0 .. 3] magic (NBD_REQUEST_MAGIC)
508 [ 4 .. 7] type (0 == READ, 1 == WRITE)
514 magic = be32_to_cpup((uint32_t*)buf);
515 request->type = be32_to_cpup((uint32_t*)(buf + 4));
516 request->handle = be64_to_cpup((uint64_t*)(buf + 8));
517 request->from = be64_to_cpup((uint64_t*)(buf + 16));
518 request->len = be32_to_cpup((uint32_t*)(buf + 24));
520 TRACE("Got request: "
521 "{ magic = 0x%x, .type = %d, from = %" PRIu64" , len = %u }",
522 magic, request->type, request->from, request->len);
524 if (magic != NBD_REQUEST_MAGIC) {
525 LOG("invalid magic (got 0x%x)", magic);
532 ssize_t nbd_receive_reply(int csock, struct nbd_reply *reply)
534 uint8_t buf[NBD_REPLY_SIZE];
537 if (read_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
544 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
545 [ 4 .. 7] error (0 == no error)
549 magic = be32_to_cpup((uint32_t*)buf);
550 reply->error = be32_to_cpup((uint32_t*)(buf + 4));
551 reply->handle = be64_to_cpup((uint64_t*)(buf + 8));
554 "{ magic = 0x%x, .error = %d, handle = %" PRIu64" }",
555 magic, reply->error, reply->handle);
557 if (magic != NBD_REPLY_MAGIC) {
558 LOG("invalid magic (got 0x%x)", magic);
565 static ssize_t nbd_send_reply(int csock, struct nbd_reply *reply)
567 uint8_t buf[4 + 4 + 8];
570 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
571 [ 4 .. 7] error (0 == no error)
574 cpu_to_be32w((uint32_t*)buf, NBD_REPLY_MAGIC);
575 cpu_to_be32w((uint32_t*)(buf + 4), reply->error);
576 cpu_to_be64w((uint64_t*)(buf + 8), reply->handle);
578 TRACE("Sending response to client");
580 if (write_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
581 LOG("writing to socket failed");
588 #define MAX_NBD_REQUESTS 16
590 typedef struct NBDRequest NBDRequest;
593 QSIMPLEQ_ENTRY(NBDRequest) entry;
599 BlockDriverState *bs;
603 QSIMPLEQ_HEAD(, NBDRequest) requests;
608 void (*close)(NBDClient *client);
613 Coroutine *recv_coroutine;
616 Coroutine *send_coroutine;
621 static void nbd_client_get(NBDClient *client)
626 static void nbd_client_put(NBDClient *client)
628 if (--client->refcount == 0) {
633 static void nbd_client_close(NBDClient *client)
635 qemu_set_fd_handler2(client->sock, NULL, NULL, NULL, NULL);
639 client->close(client);
641 nbd_client_put(client);
644 static NBDRequest *nbd_request_get(NBDClient *client)
647 NBDExport *exp = client->exp;
649 assert(client->nb_requests <= MAX_NBD_REQUESTS - 1);
650 client->nb_requests++;
652 if (QSIMPLEQ_EMPTY(&exp->requests)) {
653 req = g_malloc0(sizeof(NBDRequest));
654 req->data = qemu_blockalign(exp->bs, NBD_BUFFER_SIZE);
656 req = QSIMPLEQ_FIRST(&exp->requests);
657 QSIMPLEQ_REMOVE_HEAD(&exp->requests, entry);
659 nbd_client_get(client);
660 req->client = client;
664 static void nbd_request_put(NBDRequest *req)
666 NBDClient *client = req->client;
667 QSIMPLEQ_INSERT_HEAD(&client->exp->requests, req, entry);
668 if (client->nb_requests-- == MAX_NBD_REQUESTS) {
671 nbd_client_put(client);
674 NBDExport *nbd_export_new(BlockDriverState *bs, off_t dev_offset,
675 off_t size, uint32_t nbdflags)
677 NBDExport *exp = g_malloc0(sizeof(NBDExport));
678 QSIMPLEQ_INIT(&exp->requests);
680 exp->dev_offset = dev_offset;
681 exp->nbdflags = nbdflags;
682 exp->size = size == -1 ? exp->bs->total_sectors * 512 : size;
686 void nbd_export_close(NBDExport *exp)
688 while (!QSIMPLEQ_EMPTY(&exp->requests)) {
689 NBDRequest *first = QSIMPLEQ_FIRST(&exp->requests);
690 QSIMPLEQ_REMOVE_HEAD(&exp->requests, entry);
691 qemu_vfree(first->data);
699 static int nbd_can_read(void *opaque);
700 static void nbd_read(void *opaque);
701 static void nbd_restart_write(void *opaque);
703 static ssize_t nbd_co_send_reply(NBDRequest *req, struct nbd_reply *reply,
706 NBDClient *client = req->client;
707 int csock = client->sock;
710 qemu_co_mutex_lock(&client->send_lock);
711 qemu_set_fd_handler2(csock, nbd_can_read, nbd_read,
712 nbd_restart_write, client);
713 client->send_coroutine = qemu_coroutine_self();
716 rc = nbd_send_reply(csock, reply);
721 socket_set_cork(csock, 1);
722 rc = nbd_send_reply(csock, reply);
724 ret = qemu_co_send(csock, req->data, len);
733 socket_set_cork(csock, 0);
736 client->send_coroutine = NULL;
737 qemu_set_fd_handler2(csock, nbd_can_read, nbd_read, NULL, client);
738 qemu_co_mutex_unlock(&client->send_lock);
742 static ssize_t nbd_co_receive_request(NBDRequest *req, struct nbd_request *request)
744 NBDClient *client = req->client;
745 int csock = client->sock;
748 client->recv_coroutine = qemu_coroutine_self();
749 if (nbd_receive_request(csock, request) == -1) {
754 if (request->len > NBD_BUFFER_SIZE) {
755 LOG("len (%u) is larger than max len (%u)",
756 request->len, NBD_BUFFER_SIZE);
761 if ((request->from + request->len) < request->from) {
762 LOG("integer overflow detected! "
763 "you're probably being attacked");
768 TRACE("Decoding type");
770 if ((request->type & NBD_CMD_MASK_COMMAND) == NBD_CMD_WRITE) {
771 TRACE("Reading %u byte(s)", request->len);
773 if (qemu_co_recv(csock, req->data, request->len) != request->len) {
774 LOG("reading from socket failed");
782 client->recv_coroutine = NULL;
786 static void nbd_trip(void *opaque)
788 NBDClient *client = opaque;
789 NBDRequest *req = nbd_request_get(client);
790 NBDExport *exp = client->exp;
791 struct nbd_request request;
792 struct nbd_reply reply;
795 TRACE("Reading request.");
797 ret = nbd_co_receive_request(req, &request);
802 reply.handle = request.handle;
810 if ((request.from + request.len) > exp->size) {
811 LOG("From: %" PRIu64 ", Len: %u, Size: %" PRIu64
812 ", Offset: %" PRIu64 "\n",
813 request.from, request.len,
814 (uint64_t)exp->size, (uint64_t)exp->dev_offset);
815 LOG("requested operation past EOF--bad client?");
816 goto invalid_request;
819 switch (request.type & NBD_CMD_MASK_COMMAND) {
821 TRACE("Request type is READ");
823 ret = bdrv_read(exp->bs, (request.from + exp->dev_offset) / 512,
824 req->data, request.len / 512);
826 LOG("reading from file failed");
831 TRACE("Read %u byte(s)", request.len);
832 if (nbd_co_send_reply(req, &reply, request.len) < 0)
836 TRACE("Request type is WRITE");
838 if (exp->nbdflags & NBD_FLAG_READ_ONLY) {
839 TRACE("Server is read-only, return error");
844 TRACE("Writing to device");
846 ret = bdrv_write(exp->bs, (request.from + exp->dev_offset) / 512,
847 req->data, request.len / 512);
849 LOG("writing to file failed");
854 if (request.type & NBD_CMD_FLAG_FUA) {
855 ret = bdrv_co_flush(exp->bs);
863 if (nbd_co_send_reply(req, &reply, 0) < 0)
867 TRACE("Request type is DISCONNECT");
871 TRACE("Request type is FLUSH");
873 ret = bdrv_co_flush(exp->bs);
879 if (nbd_co_send_reply(req, &reply, 0) < 0)
883 TRACE("Request type is TRIM");
884 ret = bdrv_co_discard(exp->bs, (request.from + exp->dev_offset) / 512,
887 LOG("discard failed");
890 if (nbd_co_send_reply(req, &reply, 0) < 0)
894 LOG("invalid request type (%u) received", request.type);
896 reply.error = -EINVAL;
898 if (nbd_co_send_reply(req, &reply, 0) == -1)
903 TRACE("Request/Reply complete");
905 nbd_request_put(req);
909 nbd_request_put(req);
910 nbd_client_close(client);
913 static int nbd_can_read(void *opaque)
915 NBDClient *client = opaque;
917 return client->recv_coroutine || client->nb_requests < MAX_NBD_REQUESTS;
920 static void nbd_read(void *opaque)
922 NBDClient *client = opaque;
924 if (client->recv_coroutine) {
925 qemu_coroutine_enter(client->recv_coroutine, NULL);
927 qemu_coroutine_enter(qemu_coroutine_create(nbd_trip), client);
931 static void nbd_restart_write(void *opaque)
933 NBDClient *client = opaque;
935 qemu_coroutine_enter(client->send_coroutine, NULL);
938 NBDClient *nbd_client_new(NBDExport *exp, int csock,
939 void (*close)(NBDClient *))
942 if (nbd_send_negotiate(csock, exp->size, exp->nbdflags) == -1) {
945 client = g_malloc0(sizeof(NBDClient));
946 client->refcount = 1;
948 client->sock = csock;
949 client->close = close;
950 qemu_co_mutex_init(&client->send_lock);
951 qemu_set_fd_handler2(csock, nbd_can_read, nbd_read, NULL, client);