]> git.proxmox.com Git - qemu.git/blame - nbd.c
fw_cfg: Splash image loader can overrun a stack variable, fix
[qemu.git] / nbd.c
CommitLineData
75818250 1/*
7a5ca864
FB
2 * Copyright (C) 2005 Anthony Liguori <anthony@codemonkey.ws>
3 *
4 * Network Block Device
5 *
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.
9 *
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.
14 *
15 * You should have received a copy of the GNU General Public License
8167ee88 16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
75818250 17 */
7a5ca864 18
737e150e
PB
19#include "block/nbd.h"
20#include "block/block.h"
7a5ca864 21
737e150e 22#include "block/coroutine.h"
262db388 23
7a5ca864
FB
24#include <errno.h>
25#include <string.h>
03ff3ca3 26#ifndef _WIN32
7a5ca864 27#include <sys/ioctl.h>
03ff3ca3 28#endif
5dc2eec9 29#if defined(__sun__) || defined(__HAIKU__)
7e00eb9b
AL
30#include <sys/ioccom.h>
31#endif
7a5ca864
FB
32#include <ctype.h>
33#include <inttypes.h>
75818250 34
b90fb4b8
PB
35#ifdef __linux__
36#include <linux/fs.h>
37#endif
38
1de7afc9
PB
39#include "qemu/sockets.h"
40#include "qemu/queue.h"
03ff3ca3
AL
41
42//#define DEBUG_NBD
43
44#ifdef DEBUG_NBD
75818250 45#define TRACE(msg, ...) do { \
03ff3ca3 46 LOG(msg, ## __VA_ARGS__); \
75818250 47} while(0)
03ff3ca3
AL
48#else
49#define TRACE(msg, ...) \
50 do { } while (0)
51#endif
7a5ca864
FB
52
53#define LOG(msg, ...) do { \
54 fprintf(stderr, "%s:%s():L%d: " msg "\n", \
55 __FILE__, __FUNCTION__, __LINE__, ## __VA_ARGS__); \
56} while(0)
57
7a5ca864
FB
58/* This is all part of the "official" NBD API */
59
fa26c26b 60#define NBD_REQUEST_SIZE (4 + 4 + 8 + 8 + 4)
b2e3d87f 61#define NBD_REPLY_SIZE (4 + 4 + 8)
7a5ca864
FB
62#define NBD_REQUEST_MAGIC 0x25609513
63#define NBD_REPLY_MAGIC 0x67446698
fa26c26b
PB
64#define NBD_OPTS_MAGIC 0x49484156454F5054LL
65#define NBD_CLIENT_MAGIC 0x0000420281861253LL
7a5ca864
FB
66
67#define NBD_SET_SOCK _IO(0xab, 0)
68#define NBD_SET_BLKSIZE _IO(0xab, 1)
69#define NBD_SET_SIZE _IO(0xab, 2)
70#define NBD_DO_IT _IO(0xab, 3)
71#define NBD_CLEAR_SOCK _IO(0xab, 4)
72#define NBD_CLEAR_QUE _IO(0xab, 5)
b2e3d87f
NT
73#define NBD_PRINT_DEBUG _IO(0xab, 6)
74#define NBD_SET_SIZE_BLOCKS _IO(0xab, 7)
7a5ca864 75#define NBD_DISCONNECT _IO(0xab, 8)
bbb74edd
PB
76#define NBD_SET_TIMEOUT _IO(0xab, 9)
77#define NBD_SET_FLAGS _IO(0xab, 10)
7a5ca864 78
b2e3d87f 79#define NBD_OPT_EXPORT_NAME (1 << 0)
1d45f8b5 80
9a304d29
PB
81/* Definitions for opaque data types */
82
83typedef struct NBDRequest NBDRequest;
84
85struct NBDRequest {
86 QSIMPLEQ_ENTRY(NBDRequest) entry;
87 NBDClient *client;
88 uint8_t *data;
89};
90
91struct NBDExport {
2c8d9f06 92 int refcount;
0ddf08db
PB
93 void (*close)(NBDExport *exp);
94
9a304d29 95 BlockDriverState *bs;
ee0a19ec 96 char *name;
9a304d29
PB
97 off_t dev_offset;
98 off_t size;
99 uint32_t nbdflags;
4b9441f6 100 QTAILQ_HEAD(, NBDClient) clients;
9a304d29 101 QSIMPLEQ_HEAD(, NBDRequest) requests;
ee0a19ec 102 QTAILQ_ENTRY(NBDExport) next;
9a304d29
PB
103};
104
ee0a19ec
PB
105static QTAILQ_HEAD(, NBDExport) exports = QTAILQ_HEAD_INITIALIZER(exports);
106
9a304d29
PB
107struct NBDClient {
108 int refcount;
109 void (*close)(NBDClient *client);
110
111 NBDExport *exp;
112 int sock;
113
114 Coroutine *recv_coroutine;
115
116 CoMutex send_lock;
117 Coroutine *send_coroutine;
118
4b9441f6 119 QTAILQ_ENTRY(NBDClient) next;
9a304d29 120 int nb_requests;
ff2b68aa 121 bool closing;
9a304d29
PB
122};
123
7a5ca864
FB
124/* That's all folks */
125
185b4338 126ssize_t nbd_wr_sync(int fd, void *buffer, size_t size, bool do_read)
7a5ca864
FB
127{
128 size_t offset = 0;
185b4338 129 int err;
7a5ca864 130
ae255e52
PB
131 if (qemu_in_coroutine()) {
132 if (do_read) {
133 return qemu_co_recv(fd, buffer, size);
134 } else {
135 return qemu_co_send(fd, buffer, size);
136 }
137 }
138
7a5ca864
FB
139 while (offset < size) {
140 ssize_t len;
141
142 if (do_read) {
00aa0040 143 len = qemu_recv(fd, buffer + offset, size - offset, 0);
7a5ca864 144 } else {
03ff3ca3 145 len = send(fd, buffer + offset, size - offset, 0);
7a5ca864
FB
146 }
147
fc19f8a0 148 if (len < 0) {
185b4338 149 err = socket_error();
03ff3ca3 150
fc19f8a0 151 /* recoverable error */
7fe7b68b 152 if (err == EINTR || (offset > 0 && err == EAGAIN)) {
fc19f8a0
PB
153 continue;
154 }
155
156 /* unrecoverable error */
185b4338 157 return -err;
7a5ca864
FB
158 }
159
160 /* eof */
161 if (len == 0) {
162 break;
163 }
164
7a5ca864
FB
165 offset += len;
166 }
167
168 return offset;
169}
170
7fe7b68b
PB
171static ssize_t read_sync(int fd, void *buffer, size_t size)
172{
173 /* Sockets are kept in blocking mode in the negotiation phase. After
174 * that, a non-readable socket simply means that another thread stole
175 * our request/reply. Synchronization is done with recv_coroutine, so
176 * that this is coroutine-safe.
177 */
178 return nbd_wr_sync(fd, buffer, size, true);
179}
180
181static ssize_t write_sync(int fd, void *buffer, size_t size)
182{
183 int ret;
184 do {
185 /* For writes, we do expect the socket to be writable. */
186 ret = nbd_wr_sync(fd, buffer, size, false);
187 } while (ret == -EAGAIN);
188 return ret;
189}
190
c12504ce
NT
191static void combine_addr(char *buf, size_t len, const char* address,
192 uint16_t port)
7a5ca864 193{
c12504ce
NT
194 /* If the address-part contains a colon, it's an IPv6 IP so needs [] */
195 if (strstr(address, ":")) {
196 snprintf(buf, len, "[%s]:%u", address, port);
197 } else {
198 snprintf(buf, len, "%s:%u", address, port);
7a5ca864 199 }
7a5ca864
FB
200}
201
c12504ce 202int tcp_socket_outgoing(const char *address, uint16_t port)
7a5ca864 203{
c12504ce
NT
204 char address_and_port[128];
205 combine_addr(address_and_port, 128, address, port);
206 return tcp_socket_outgoing_spec(address_and_port);
7a5ca864
FB
207}
208
c12504ce 209int tcp_socket_outgoing_spec(const char *address_and_port)
cd831bd7 210{
f8430e76
PB
211 Error *local_err = NULL;
212 int fd = inet_connect(address_and_port, &local_err);
213
214 if (local_err != NULL) {
215 qerror_report_err(local_err);
216 error_free(local_err);
217 }
218 return fd;
cd831bd7
TS
219}
220
c12504ce 221int tcp_socket_incoming(const char *address, uint16_t port)
cd831bd7 222{
c12504ce
NT
223 char address_and_port[128];
224 combine_addr(address_and_port, 128, address, port);
225 return tcp_socket_incoming_spec(address_and_port);
226}
cd831bd7 227
c12504ce
NT
228int tcp_socket_incoming_spec(const char *address_and_port)
229{
f8430e76
PB
230 Error *local_err = NULL;
231 int fd = inet_listen(address_and_port, NULL, 0, SOCK_STREAM, 0, &local_err);
232
233 if (local_err != NULL) {
234 qerror_report_err(local_err);
235 error_free(local_err);
236 }
237 return fd;
03ff3ca3 238}
c12504ce 239
03ff3ca3
AL
240int unix_socket_incoming(const char *path)
241{
f8430e76
PB
242 Error *local_err = NULL;
243 int fd = unix_listen(path, NULL, 0, &local_err);
c12504ce 244
f8430e76
PB
245 if (local_err != NULL) {
246 qerror_report_err(local_err);
247 error_free(local_err);
248 }
249 return fd;
cd831bd7
TS
250}
251
03ff3ca3
AL
252int unix_socket_outgoing(const char *path)
253{
f8430e76
PB
254 Error *local_err = NULL;
255 int fd = unix_connect(path, &local_err);
256
257 if (local_err != NULL) {
258 qerror_report_err(local_err);
259 error_free(local_err);
260 }
261 return fd;
03ff3ca3 262}
cd831bd7 263
6b8c01e7 264/* Basic flow for negotiation
7a5ca864
FB
265
266 Server Client
7a5ca864 267 Negotiate
6b8c01e7
PB
268
269 or
270
271 Server Client
272 Negotiate #1
273 Option
274 Negotiate #2
275
276 ----
277
278 followed by
279
280 Server Client
7a5ca864
FB
281 Request
282 Response
283 Request
284 Response
285 ...
286 ...
287 Request (type == 2)
6b8c01e7 288
7a5ca864
FB
289*/
290
6b8c01e7
PB
291static int nbd_receive_options(NBDClient *client)
292{
293 int csock = client->sock;
294 char name[256];
295 uint32_t tmp, length;
296 uint64_t magic;
297 int rc;
298
299 /* Client sends:
300 [ 0 .. 3] reserved (0)
301 [ 4 .. 11] NBD_OPTS_MAGIC
302 [12 .. 15] NBD_OPT_EXPORT_NAME
303 [16 .. 19] length
304 [20 .. xx] export name (length bytes)
305 */
306
307 rc = -EINVAL;
308 if (read_sync(csock, &tmp, sizeof(tmp)) != sizeof(tmp)) {
309 LOG("read failed");
310 goto fail;
311 }
312 TRACE("Checking reserved");
313 if (tmp != 0) {
314 LOG("Bad reserved received");
315 goto fail;
316 }
317
318 if (read_sync(csock, &magic, sizeof(magic)) != sizeof(magic)) {
319 LOG("read failed");
320 goto fail;
321 }
322 TRACE("Checking reserved");
323 if (magic != be64_to_cpu(NBD_OPTS_MAGIC)) {
324 LOG("Bad magic received");
325 goto fail;
326 }
327
328 if (read_sync(csock, &tmp, sizeof(tmp)) != sizeof(tmp)) {
329 LOG("read failed");
330 goto fail;
331 }
332 TRACE("Checking option");
333 if (tmp != be32_to_cpu(NBD_OPT_EXPORT_NAME)) {
334 LOG("Bad option received");
335 goto fail;
336 }
337
338 if (read_sync(csock, &length, sizeof(length)) != sizeof(length)) {
339 LOG("read failed");
340 goto fail;
341 }
342 TRACE("Checking length");
343 length = be32_to_cpu(length);
344 if (length > 255) {
345 LOG("Bad length received");
346 goto fail;
347 }
348 if (read_sync(csock, name, length) != length) {
349 LOG("read failed");
350 goto fail;
351 }
352 name[length] = '\0';
353
354 client->exp = nbd_export_find(name);
355 if (!client->exp) {
356 LOG("export not found");
357 goto fail;
358 }
359
360 QTAILQ_INSERT_TAIL(&client->exp->clients, client, next);
361 nbd_export_get(client->exp);
362
363 TRACE("Option negotiation succeeded.");
364 rc = 0;
365fail:
366 return rc;
367}
368
9a304d29 369static int nbd_send_negotiate(NBDClient *client)
7a5ca864 370{
9a304d29 371 int csock = client->sock;
b2e3d87f 372 char buf[8 + 8 + 8 + 128];
185b4338 373 int rc;
6b8c01e7
PB
374 const int myflags = (NBD_FLAG_HAS_FLAGS | NBD_FLAG_SEND_TRIM |
375 NBD_FLAG_SEND_FLUSH | NBD_FLAG_SEND_FUA);
b2e3d87f 376
6b8c01e7
PB
377 /* Negotiation header without options:
378 [ 0 .. 7] passwd ("NBDMAGIC")
379 [ 8 .. 15] magic (NBD_CLIENT_MAGIC)
b2e3d87f 380 [16 .. 23] size
6b8c01e7
PB
381 [24 .. 25] server flags (0)
382 [24 .. 27] export flags
383 [28 .. 151] reserved (0)
384
385 Negotiation header with options, part 1:
386 [ 0 .. 7] passwd ("NBDMAGIC")
387 [ 8 .. 15] magic (NBD_OPTS_MAGIC)
388 [16 .. 17] server flags (0)
389
390 part 2 (after options are sent):
391 [18 .. 25] size
392 [26 .. 27] export flags
393 [28 .. 151] reserved (0)
b2e3d87f
NT
394 */
395
7fe7b68b 396 socket_set_block(csock);
185b4338
PB
397 rc = -EINVAL;
398
b2e3d87f 399 TRACE("Beginning negotiation.");
8ffaaba0 400 memset(buf, 0, sizeof(buf));
b2e3d87f 401 memcpy(buf, "NBDMAGIC", 8);
6b8c01e7
PB
402 if (client->exp) {
403 assert ((client->exp->nbdflags & ~65535) == 0);
404 cpu_to_be64w((uint64_t*)(buf + 8), NBD_CLIENT_MAGIC);
405 cpu_to_be64w((uint64_t*)(buf + 16), client->exp->size);
406 cpu_to_be16w((uint16_t*)(buf + 26), client->exp->nbdflags | myflags);
407 } else {
408 cpu_to_be64w((uint64_t*)(buf + 8), NBD_OPTS_MAGIC);
409 }
b2e3d87f 410
6b8c01e7
PB
411 if (client->exp) {
412 if (write_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
413 LOG("write failed");
414 goto fail;
415 }
416 } else {
417 if (write_sync(csock, buf, 18) != 18) {
418 LOG("write failed");
419 goto fail;
420 }
421 rc = nbd_receive_options(client);
422 if (rc < 0) {
423 LOG("option negotiation failed");
424 goto fail;
425 }
426
427 assert ((client->exp->nbdflags & ~65535) == 0);
428 cpu_to_be64w((uint64_t*)(buf + 18), client->exp->size);
429 cpu_to_be16w((uint16_t*)(buf + 26), client->exp->nbdflags | myflags);
430 if (write_sync(csock, buf + 18, sizeof(buf) - 18) != sizeof(buf) - 18) {
431 LOG("write failed");
432 goto fail;
433 }
b2e3d87f
NT
434 }
435
07f35073 436 TRACE("Negotiation succeeded.");
185b4338
PB
437 rc = 0;
438fail:
7fe7b68b 439 socket_set_nonblock(csock);
185b4338 440 return rc;
7a5ca864
FB
441}
442
1d45f8b5
LV
443int nbd_receive_negotiate(int csock, const char *name, uint32_t *flags,
444 off_t *size, size_t *blocksize)
7a5ca864 445{
b2e3d87f
NT
446 char buf[256];
447 uint64_t magic, s;
448 uint16_t tmp;
185b4338 449 int rc;
b2e3d87f 450
07f35073 451 TRACE("Receiving negotiation.");
b2e3d87f 452
7fe7b68b 453 socket_set_block(csock);
185b4338
PB
454 rc = -EINVAL;
455
b2e3d87f
NT
456 if (read_sync(csock, buf, 8) != 8) {
457 LOG("read failed");
185b4338 458 goto fail;
b2e3d87f
NT
459 }
460
461 buf[8] = '\0';
462 if (strlen(buf) == 0) {
463 LOG("server connection closed");
185b4338 464 goto fail;
b2e3d87f
NT
465 }
466
467 TRACE("Magic is %c%c%c%c%c%c%c%c",
468 qemu_isprint(buf[0]) ? buf[0] : '.',
469 qemu_isprint(buf[1]) ? buf[1] : '.',
470 qemu_isprint(buf[2]) ? buf[2] : '.',
471 qemu_isprint(buf[3]) ? buf[3] : '.',
472 qemu_isprint(buf[4]) ? buf[4] : '.',
473 qemu_isprint(buf[5]) ? buf[5] : '.',
474 qemu_isprint(buf[6]) ? buf[6] : '.',
475 qemu_isprint(buf[7]) ? buf[7] : '.');
476
477 if (memcmp(buf, "NBDMAGIC", 8) != 0) {
478 LOG("Invalid magic received");
185b4338 479 goto fail;
b2e3d87f
NT
480 }
481
482 if (read_sync(csock, &magic, sizeof(magic)) != sizeof(magic)) {
483 LOG("read failed");
185b4338 484 goto fail;
b2e3d87f
NT
485 }
486 magic = be64_to_cpu(magic);
487 TRACE("Magic is 0x%" PRIx64, magic);
488
489 if (name) {
490 uint32_t reserved = 0;
491 uint32_t opt;
492 uint32_t namesize;
493
494 TRACE("Checking magic (opts_magic)");
fa26c26b 495 if (magic != NBD_OPTS_MAGIC) {
b2e3d87f 496 LOG("Bad magic received");
185b4338 497 goto fail;
b2e3d87f
NT
498 }
499 if (read_sync(csock, &tmp, sizeof(tmp)) != sizeof(tmp)) {
500 LOG("flags read failed");
185b4338 501 goto fail;
b2e3d87f
NT
502 }
503 *flags = be16_to_cpu(tmp) << 16;
504 /* reserved for future use */
505 if (write_sync(csock, &reserved, sizeof(reserved)) !=
506 sizeof(reserved)) {
507 LOG("write failed (reserved)");
185b4338 508 goto fail;
b2e3d87f
NT
509 }
510 /* write the export name */
511 magic = cpu_to_be64(magic);
512 if (write_sync(csock, &magic, sizeof(magic)) != sizeof(magic)) {
513 LOG("write failed (magic)");
185b4338 514 goto fail;
b2e3d87f
NT
515 }
516 opt = cpu_to_be32(NBD_OPT_EXPORT_NAME);
517 if (write_sync(csock, &opt, sizeof(opt)) != sizeof(opt)) {
518 LOG("write failed (opt)");
185b4338 519 goto fail;
b2e3d87f
NT
520 }
521 namesize = cpu_to_be32(strlen(name));
522 if (write_sync(csock, &namesize, sizeof(namesize)) !=
523 sizeof(namesize)) {
524 LOG("write failed (namesize)");
185b4338 525 goto fail;
b2e3d87f
NT
526 }
527 if (write_sync(csock, (char*)name, strlen(name)) != strlen(name)) {
528 LOG("write failed (name)");
185b4338 529 goto fail;
b2e3d87f
NT
530 }
531 } else {
532 TRACE("Checking magic (cli_magic)");
533
fa26c26b 534 if (magic != NBD_CLIENT_MAGIC) {
b2e3d87f 535 LOG("Bad magic received");
185b4338 536 goto fail;
b2e3d87f
NT
537 }
538 }
539
540 if (read_sync(csock, &s, sizeof(s)) != sizeof(s)) {
541 LOG("read failed");
185b4338 542 goto fail;
b2e3d87f
NT
543 }
544 *size = be64_to_cpu(s);
545 *blocksize = 1024;
546 TRACE("Size is %" PRIu64, *size);
547
548 if (!name) {
549 if (read_sync(csock, flags, sizeof(*flags)) != sizeof(*flags)) {
550 LOG("read failed (flags)");
185b4338 551 goto fail;
b2e3d87f
NT
552 }
553 *flags = be32_to_cpup(flags);
554 } else {
555 if (read_sync(csock, &tmp, sizeof(tmp)) != sizeof(tmp)) {
556 LOG("read failed (tmp)");
185b4338 557 goto fail;
b2e3d87f
NT
558 }
559 *flags |= be32_to_cpu(tmp);
560 }
561 if (read_sync(csock, &buf, 124) != 124) {
562 LOG("read failed (buf)");
185b4338 563 goto fail;
b2e3d87f 564 }
185b4338
PB
565 rc = 0;
566
567fail:
7fe7b68b 568 socket_set_nonblock(csock);
185b4338 569 return rc;
cd831bd7 570}
7a5ca864 571
b90fb4b8
PB
572#ifdef __linux__
573int nbd_init(int fd, int csock, uint32_t flags, off_t size, size_t blocksize)
cd831bd7 574{
3e05c785
CL
575 TRACE("Setting NBD socket");
576
fc19f8a0 577 if (ioctl(fd, NBD_SET_SOCK, csock) < 0) {
3e05c785
CL
578 int serrno = errno;
579 LOG("Failed to set NBD socket");
185b4338 580 return -serrno;
3e05c785
CL
581 }
582
b2e3d87f 583 TRACE("Setting block size to %lu", (unsigned long)blocksize);
7a5ca864 584
fc19f8a0 585 if (ioctl(fd, NBD_SET_BLKSIZE, blocksize) < 0) {
b2e3d87f
NT
586 int serrno = errno;
587 LOG("Failed setting NBD block size");
185b4338 588 return -serrno;
b2e3d87f 589 }
7a5ca864 590
0bfcd599 591 TRACE("Setting size to %zd block(s)", (size_t)(size / blocksize));
7a5ca864 592
fc19f8a0 593 if (ioctl(fd, NBD_SET_SIZE_BLOCKS, size / blocksize) < 0) {
b2e3d87f
NT
594 int serrno = errno;
595 LOG("Failed setting size (in blocks)");
185b4338 596 return -serrno;
b2e3d87f 597 }
7a5ca864 598
c8969ede
PB
599 if (ioctl(fd, NBD_SET_FLAGS, flags) < 0) {
600 if (errno == ENOTTY) {
601 int read_only = (flags & NBD_FLAG_READ_ONLY) != 0;
602 TRACE("Setting readonly attribute");
603
604 if (ioctl(fd, BLKROSET, (unsigned long) &read_only) < 0) {
605 int serrno = errno;
606 LOG("Failed setting read-only attribute");
607 return -serrno;
608 }
609 } else {
b90fb4b8 610 int serrno = errno;
c8969ede 611 LOG("Failed setting flags");
185b4338 612 return -serrno;
b90fb4b8
PB
613 }
614 }
615
b2e3d87f 616 TRACE("Negotiation ended");
7a5ca864 617
b2e3d87f 618 return 0;
7a5ca864
FB
619}
620
621int nbd_disconnect(int fd)
622{
b2e3d87f
NT
623 ioctl(fd, NBD_CLEAR_QUE);
624 ioctl(fd, NBD_DISCONNECT);
625 ioctl(fd, NBD_CLEAR_SOCK);
626 return 0;
7a5ca864
FB
627}
628
0a4eb864 629int nbd_client(int fd)
7a5ca864 630{
b2e3d87f
NT
631 int ret;
632 int serrno;
7a5ca864 633
b2e3d87f 634 TRACE("Doing NBD loop");
7a5ca864 635
b2e3d87f 636 ret = ioctl(fd, NBD_DO_IT);
fc19f8a0 637 if (ret < 0 && errno == EPIPE) {
74624688
PB
638 /* NBD_DO_IT normally returns EPIPE when someone has disconnected
639 * the socket via NBD_DISCONNECT. We do not want to return 1 in
640 * that case.
641 */
642 ret = 0;
643 }
b2e3d87f 644 serrno = errno;
7a5ca864 645
b2e3d87f 646 TRACE("NBD loop returned %d: %s", ret, strerror(serrno));
7a5ca864 647
b2e3d87f
NT
648 TRACE("Clearing NBD queue");
649 ioctl(fd, NBD_CLEAR_QUE);
7a5ca864 650
b2e3d87f
NT
651 TRACE("Clearing NBD socket");
652 ioctl(fd, NBD_CLEAR_SOCK);
7a5ca864 653
b2e3d87f
NT
654 errno = serrno;
655 return ret;
7a5ca864 656}
03ff3ca3 657#else
8e72506e 658int nbd_init(int fd, int csock, uint32_t flags, off_t size, size_t blocksize)
03ff3ca3 659{
185b4338 660 return -ENOTSUP;
03ff3ca3
AL
661}
662
663int nbd_disconnect(int fd)
664{
185b4338 665 return -ENOTSUP;
03ff3ca3
AL
666}
667
0a4eb864 668int nbd_client(int fd)
03ff3ca3 669{
185b4338 670 return -ENOTSUP;
03ff3ca3
AL
671}
672#endif
7a5ca864 673
94e7340b 674ssize_t nbd_send_request(int csock, struct nbd_request *request)
7a5ca864 675{
fa26c26b 676 uint8_t buf[NBD_REQUEST_SIZE];
185b4338 677 ssize_t ret;
b2e3d87f
NT
678
679 cpu_to_be32w((uint32_t*)buf, NBD_REQUEST_MAGIC);
680 cpu_to_be32w((uint32_t*)(buf + 4), request->type);
681 cpu_to_be64w((uint64_t*)(buf + 8), request->handle);
682 cpu_to_be64w((uint64_t*)(buf + 16), request->from);
683 cpu_to_be32w((uint32_t*)(buf + 24), request->len);
75818250 684
b2e3d87f
NT
685 TRACE("Sending request to client: "
686 "{ .from = %" PRIu64", .len = %u, .handle = %" PRIu64", .type=%i}",
687 request->from, request->len, request->handle, request->type);
688
185b4338
PB
689 ret = write_sync(csock, buf, sizeof(buf));
690 if (ret < 0) {
691 return ret;
692 }
693
694 if (ret != sizeof(buf)) {
b2e3d87f 695 LOG("writing to socket failed");
185b4338 696 return -EINVAL;
b2e3d87f
NT
697 }
698 return 0;
699}
75818250 700
94e7340b 701static ssize_t nbd_receive_request(int csock, struct nbd_request *request)
75818250 702{
fa26c26b 703 uint8_t buf[NBD_REQUEST_SIZE];
b2e3d87f 704 uint32_t magic;
185b4338 705 ssize_t ret;
b2e3d87f 706
185b4338
PB
707 ret = read_sync(csock, buf, sizeof(buf));
708 if (ret < 0) {
709 return ret;
710 }
711
712 if (ret != sizeof(buf)) {
b2e3d87f 713 LOG("read failed");
185b4338 714 return -EINVAL;
b2e3d87f
NT
715 }
716
717 /* Request
718 [ 0 .. 3] magic (NBD_REQUEST_MAGIC)
719 [ 4 .. 7] type (0 == READ, 1 == WRITE)
720 [ 8 .. 15] handle
721 [16 .. 23] from
722 [24 .. 27] len
723 */
724
725 magic = be32_to_cpup((uint32_t*)buf);
726 request->type = be32_to_cpup((uint32_t*)(buf + 4));
727 request->handle = be64_to_cpup((uint64_t*)(buf + 8));
728 request->from = be64_to_cpup((uint64_t*)(buf + 16));
729 request->len = be32_to_cpup((uint32_t*)(buf + 24));
730
731 TRACE("Got request: "
732 "{ magic = 0x%x, .type = %d, from = %" PRIu64" , len = %u }",
733 magic, request->type, request->from, request->len);
734
735 if (magic != NBD_REQUEST_MAGIC) {
736 LOG("invalid magic (got 0x%x)", magic);
185b4338 737 return -EINVAL;
b2e3d87f
NT
738 }
739 return 0;
75818250
TS
740}
741
94e7340b 742ssize_t nbd_receive_reply(int csock, struct nbd_reply *reply)
75818250 743{
b2e3d87f
NT
744 uint8_t buf[NBD_REPLY_SIZE];
745 uint32_t magic;
185b4338 746 ssize_t ret;
b2e3d87f 747
185b4338
PB
748 ret = read_sync(csock, buf, sizeof(buf));
749 if (ret < 0) {
750 return ret;
751 }
752
753 if (ret != sizeof(buf)) {
b2e3d87f 754 LOG("read failed");
185b4338 755 return -EINVAL;
b2e3d87f
NT
756 }
757
758 /* Reply
759 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
760 [ 4 .. 7] error (0 == no error)
761 [ 7 .. 15] handle
762 */
763
764 magic = be32_to_cpup((uint32_t*)buf);
765 reply->error = be32_to_cpup((uint32_t*)(buf + 4));
766 reply->handle = be64_to_cpup((uint64_t*)(buf + 8));
767
768 TRACE("Got reply: "
769 "{ magic = 0x%x, .error = %d, handle = %" PRIu64" }",
770 magic, reply->error, reply->handle);
771
772 if (magic != NBD_REPLY_MAGIC) {
773 LOG("invalid magic (got 0x%x)", magic);
185b4338 774 return -EINVAL;
b2e3d87f
NT
775 }
776 return 0;
75818250
TS
777}
778
94e7340b 779static ssize_t nbd_send_reply(int csock, struct nbd_reply *reply)
75818250 780{
fa26c26b 781 uint8_t buf[NBD_REPLY_SIZE];
185b4338 782 ssize_t ret;
b2e3d87f
NT
783
784 /* Reply
785 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
786 [ 4 .. 7] error (0 == no error)
787 [ 7 .. 15] handle
788 */
789 cpu_to_be32w((uint32_t*)buf, NBD_REPLY_MAGIC);
790 cpu_to_be32w((uint32_t*)(buf + 4), reply->error);
791 cpu_to_be64w((uint64_t*)(buf + 8), reply->handle);
792
793 TRACE("Sending response to client");
794
185b4338
PB
795 ret = write_sync(csock, buf, sizeof(buf));
796 if (ret < 0) {
797 return ret;
798 }
799
800 if (ret != sizeof(buf)) {
b2e3d87f 801 LOG("writing to socket failed");
185b4338 802 return -EINVAL;
b2e3d87f
NT
803 }
804 return 0;
75818250 805}
7a5ca864 806
41996e38
PB
807#define MAX_NBD_REQUESTS 16
808
ce33967a 809void nbd_client_get(NBDClient *client)
1743b515
PB
810{
811 client->refcount++;
812}
813
ce33967a 814void nbd_client_put(NBDClient *client)
1743b515
PB
815{
816 if (--client->refcount == 0) {
ff2b68aa
PB
817 /* The last reference should be dropped by client->close,
818 * which is called by nbd_client_close.
819 */
820 assert(client->closing);
821
822 qemu_set_fd_handler2(client->sock, NULL, NULL, NULL, NULL);
823 close(client->sock);
824 client->sock = -1;
6b8c01e7
PB
825 if (client->exp) {
826 QTAILQ_REMOVE(&client->exp->clients, client, next);
827 nbd_export_put(client->exp);
828 }
1743b515
PB
829 g_free(client);
830 }
831}
832
ff2b68aa 833void nbd_client_close(NBDClient *client)
1743b515 834{
ff2b68aa
PB
835 if (client->closing) {
836 return;
837 }
838
839 client->closing = true;
840
841 /* Force requests to finish. They will drop their own references,
842 * then we'll close the socket and free the NBDClient.
843 */
844 shutdown(client->sock, 2);
845
846 /* Also tell the client, so that they release their reference. */
1743b515
PB
847 if (client->close) {
848 client->close(client);
849 }
1743b515
PB
850}
851
72deddc5 852static NBDRequest *nbd_request_get(NBDClient *client)
d9a73806
PB
853{
854 NBDRequest *req;
72deddc5
PB
855 NBDExport *exp = client->exp;
856
41996e38
PB
857 assert(client->nb_requests <= MAX_NBD_REQUESTS - 1);
858 client->nb_requests++;
859
d9a73806
PB
860 if (QSIMPLEQ_EMPTY(&exp->requests)) {
861 req = g_malloc0(sizeof(NBDRequest));
862 req->data = qemu_blockalign(exp->bs, NBD_BUFFER_SIZE);
863 } else {
864 req = QSIMPLEQ_FIRST(&exp->requests);
865 QSIMPLEQ_REMOVE_HEAD(&exp->requests, entry);
866 }
72deddc5
PB
867 nbd_client_get(client);
868 req->client = client;
d9a73806
PB
869 return req;
870}
871
72deddc5 872static void nbd_request_put(NBDRequest *req)
d9a73806 873{
72deddc5
PB
874 NBDClient *client = req->client;
875 QSIMPLEQ_INSERT_HEAD(&client->exp->requests, req, entry);
41996e38
PB
876 if (client->nb_requests-- == MAX_NBD_REQUESTS) {
877 qemu_notify_event();
878 }
72deddc5 879 nbd_client_put(client);
d9a73806
PB
880}
881
af49bbbe 882NBDExport *nbd_export_new(BlockDriverState *bs, off_t dev_offset,
0ddf08db
PB
883 off_t size, uint32_t nbdflags,
884 void (*close)(NBDExport *))
af49bbbe
PB
885{
886 NBDExport *exp = g_malloc0(sizeof(NBDExport));
d9a73806 887 QSIMPLEQ_INIT(&exp->requests);
2c8d9f06 888 exp->refcount = 1;
4b9441f6 889 QTAILQ_INIT(&exp->clients);
af49bbbe
PB
890 exp->bs = bs;
891 exp->dev_offset = dev_offset;
892 exp->nbdflags = nbdflags;
38ceff04 893 exp->size = size == -1 ? bdrv_getlength(bs) : size;
0ddf08db 894 exp->close = close;
af49bbbe
PB
895 return exp;
896}
897
ee0a19ec
PB
898NBDExport *nbd_export_find(const char *name)
899{
900 NBDExport *exp;
901 QTAILQ_FOREACH(exp, &exports, next) {
902 if (strcmp(name, exp->name) == 0) {
903 return exp;
904 }
905 }
906
907 return NULL;
908}
909
910void nbd_export_set_name(NBDExport *exp, const char *name)
911{
912 if (exp->name == name) {
913 return;
914 }
915
916 nbd_export_get(exp);
917 if (exp->name != NULL) {
918 g_free(exp->name);
919 exp->name = NULL;
920 QTAILQ_REMOVE(&exports, exp, next);
921 nbd_export_put(exp);
922 }
923 if (name != NULL) {
924 nbd_export_get(exp);
925 exp->name = g_strdup(name);
926 QTAILQ_INSERT_TAIL(&exports, exp, next);
927 }
928 nbd_export_put(exp);
929}
930
af49bbbe
PB
931void nbd_export_close(NBDExport *exp)
932{
4b9441f6 933 NBDClient *client, *next;
2c8d9f06 934
4b9441f6
PB
935 nbd_export_get(exp);
936 QTAILQ_FOREACH_SAFE(client, &exp->clients, next, next) {
937 nbd_client_close(client);
938 }
125afda8 939 nbd_export_set_name(exp, NULL);
4b9441f6 940 nbd_export_put(exp);
2c8d9f06
PB
941}
942
943void nbd_export_get(NBDExport *exp)
944{
945 assert(exp->refcount > 0);
946 exp->refcount++;
947}
948
949void nbd_export_put(NBDExport *exp)
950{
951 assert(exp->refcount > 0);
952 if (exp->refcount == 1) {
953 nbd_export_close(exp);
d9a73806
PB
954 }
955
2c8d9f06 956 if (--exp->refcount == 0) {
ee0a19ec
PB
957 assert(exp->name == NULL);
958
0ddf08db
PB
959 if (exp->close) {
960 exp->close(exp);
961 }
962
2c8d9f06
PB
963 while (!QSIMPLEQ_EMPTY(&exp->requests)) {
964 NBDRequest *first = QSIMPLEQ_FIRST(&exp->requests);
965 QSIMPLEQ_REMOVE_HEAD(&exp->requests, entry);
966 qemu_vfree(first->data);
967 g_free(first);
968 }
969
970 g_free(exp);
971 }
af49bbbe
PB
972}
973
125afda8
PB
974BlockDriverState *nbd_export_get_blockdev(NBDExport *exp)
975{
976 return exp->bs;
977}
978
ee0a19ec
PB
979void nbd_export_close_all(void)
980{
981 NBDExport *exp, *next;
982
983 QTAILQ_FOREACH_SAFE(exp, &exports, next, next) {
984 nbd_export_close(exp);
ee0a19ec
PB
985 }
986}
987
41996e38 988static int nbd_can_read(void *opaque);
262db388
PB
989static void nbd_read(void *opaque);
990static void nbd_restart_write(void *opaque);
991
94e7340b
PB
992static ssize_t nbd_co_send_reply(NBDRequest *req, struct nbd_reply *reply,
993 int len)
22045592 994{
72deddc5
PB
995 NBDClient *client = req->client;
996 int csock = client->sock;
94e7340b 997 ssize_t rc, ret;
22045592 998
262db388 999 qemu_co_mutex_lock(&client->send_lock);
41996e38
PB
1000 qemu_set_fd_handler2(csock, nbd_can_read, nbd_read,
1001 nbd_restart_write, client);
262db388
PB
1002 client->send_coroutine = qemu_coroutine_self();
1003
22045592
PB
1004 if (!len) {
1005 rc = nbd_send_reply(csock, reply);
22045592
PB
1006 } else {
1007 socket_set_cork(csock, 1);
1008 rc = nbd_send_reply(csock, reply);
fc19f8a0 1009 if (rc >= 0) {
262db388 1010 ret = qemu_co_send(csock, req->data, len);
22045592 1011 if (ret != len) {
185b4338 1012 rc = -EIO;
22045592
PB
1013 }
1014 }
22045592
PB
1015 socket_set_cork(csock, 0);
1016 }
262db388
PB
1017
1018 client->send_coroutine = NULL;
41996e38 1019 qemu_set_fd_handler2(csock, nbd_can_read, nbd_read, NULL, client);
262db388 1020 qemu_co_mutex_unlock(&client->send_lock);
22045592
PB
1021 return rc;
1022}
1023
94e7340b 1024static ssize_t nbd_co_receive_request(NBDRequest *req, struct nbd_request *request)
a030b347 1025{
72deddc5
PB
1026 NBDClient *client = req->client;
1027 int csock = client->sock;
94e7340b 1028 ssize_t rc;
a030b347 1029
262db388 1030 client->recv_coroutine = qemu_coroutine_self();
7fe7b68b
PB
1031 rc = nbd_receive_request(csock, request);
1032 if (rc < 0) {
1033 if (rc != -EAGAIN) {
1034 rc = -EIO;
1035 }
a030b347
PB
1036 goto out;
1037 }
1038
1039 if (request->len > NBD_BUFFER_SIZE) {
1040 LOG("len (%u) is larger than max len (%u)",
1041 request->len, NBD_BUFFER_SIZE);
1042 rc = -EINVAL;
1043 goto out;
1044 }
1045
1046 if ((request->from + request->len) < request->from) {
1047 LOG("integer overflow detected! "
1048 "you're probably being attacked");
1049 rc = -EINVAL;
1050 goto out;
1051 }
1052
1053 TRACE("Decoding type");
1054
1055 if ((request->type & NBD_CMD_MASK_COMMAND) == NBD_CMD_WRITE) {
1056 TRACE("Reading %u byte(s)", request->len);
1057
262db388 1058 if (qemu_co_recv(csock, req->data, request->len) != request->len) {
a030b347
PB
1059 LOG("reading from socket failed");
1060 rc = -EIO;
1061 goto out;
1062 }
1063 }
1064 rc = 0;
1065
1066out:
262db388 1067 client->recv_coroutine = NULL;
a030b347
PB
1068 return rc;
1069}
1070
262db388 1071static void nbd_trip(void *opaque)
75818250 1072{
262db388 1073 NBDClient *client = opaque;
1743b515 1074 NBDExport *exp = client->exp;
ff2b68aa 1075 NBDRequest *req;
b2e3d87f
NT
1076 struct nbd_request request;
1077 struct nbd_reply reply;
94e7340b 1078 ssize_t ret;
b2e3d87f
NT
1079
1080 TRACE("Reading request.");
ff2b68aa
PB
1081 if (client->closing) {
1082 return;
1083 }
b2e3d87f 1084
ff2b68aa 1085 req = nbd_request_get(client);
262db388 1086 ret = nbd_co_receive_request(req, &request);
7fe7b68b
PB
1087 if (ret == -EAGAIN) {
1088 goto done;
1089 }
a030b347 1090 if (ret == -EIO) {
d9a73806 1091 goto out;
a030b347 1092 }
b2e3d87f 1093
fae69416
PB
1094 reply.handle = request.handle;
1095 reply.error = 0;
1096
a030b347
PB
1097 if (ret < 0) {
1098 reply.error = -ret;
1099 goto error_reply;
b2e3d87f
NT
1100 }
1101
af49bbbe 1102 if ((request.from + request.len) > exp->size) {
b2e3d87f
NT
1103 LOG("From: %" PRIu64 ", Len: %u, Size: %" PRIu64
1104 ", Offset: %" PRIu64 "\n",
af49bbbe 1105 request.from, request.len,
0fee8f34 1106 (uint64_t)exp->size, (uint64_t)exp->dev_offset);
b2e3d87f 1107 LOG("requested operation past EOF--bad client?");
fae69416 1108 goto invalid_request;
b2e3d87f
NT
1109 }
1110
2c7989a9 1111 switch (request.type & NBD_CMD_MASK_COMMAND) {
b2e3d87f
NT
1112 case NBD_CMD_READ:
1113 TRACE("Request type is READ");
1114
e25ceb76
PB
1115 if (request.type & NBD_CMD_FLAG_FUA) {
1116 ret = bdrv_co_flush(exp->bs);
1117 if (ret < 0) {
1118 LOG("flush failed");
1119 reply.error = -ret;
1120 goto error_reply;
1121 }
1122 }
1123
af49bbbe 1124 ret = bdrv_read(exp->bs, (request.from + exp->dev_offset) / 512,
d9a73806 1125 req->data, request.len / 512);
adcf6302 1126 if (ret < 0) {
b2e3d87f 1127 LOG("reading from file failed");
adcf6302 1128 reply.error = -ret;
fae69416 1129 goto error_reply;
b2e3d87f 1130 }
b2e3d87f
NT
1131
1132 TRACE("Read %u byte(s)", request.len);
262db388 1133 if (nbd_co_send_reply(req, &reply, request.len) < 0)
d9a73806 1134 goto out;
b2e3d87f
NT
1135 break;
1136 case NBD_CMD_WRITE:
1137 TRACE("Request type is WRITE");
1138
af49bbbe 1139 if (exp->nbdflags & NBD_FLAG_READ_ONLY) {
b2e3d87f 1140 TRACE("Server is read-only, return error");
fae69416
PB
1141 reply.error = EROFS;
1142 goto error_reply;
1143 }
1144
1145 TRACE("Writing to device");
1146
af49bbbe 1147 ret = bdrv_write(exp->bs, (request.from + exp->dev_offset) / 512,
d9a73806 1148 req->data, request.len / 512);
fae69416
PB
1149 if (ret < 0) {
1150 LOG("writing to file failed");
1151 reply.error = -ret;
1152 goto error_reply;
1153 }
b2e3d87f 1154
fae69416 1155 if (request.type & NBD_CMD_FLAG_FUA) {
262db388 1156 ret = bdrv_co_flush(exp->bs);
adcf6302 1157 if (ret < 0) {
fae69416 1158 LOG("flush failed");
adcf6302 1159 reply.error = -ret;
fae69416 1160 goto error_reply;
2c7989a9 1161 }
b2e3d87f
NT
1162 }
1163
fc19f8a0 1164 if (nbd_co_send_reply(req, &reply, 0) < 0) {
d9a73806 1165 goto out;
fc19f8a0 1166 }
b2e3d87f
NT
1167 break;
1168 case NBD_CMD_DISC:
1169 TRACE("Request type is DISCONNECT");
1170 errno = 0;
262db388 1171 goto out;
1486d04a
PB
1172 case NBD_CMD_FLUSH:
1173 TRACE("Request type is FLUSH");
1174
262db388 1175 ret = bdrv_co_flush(exp->bs);
1486d04a
PB
1176 if (ret < 0) {
1177 LOG("flush failed");
1178 reply.error = -ret;
1179 }
fc19f8a0 1180 if (nbd_co_send_reply(req, &reply, 0) < 0) {
d9a73806 1181 goto out;
fc19f8a0 1182 }
7a706633
PB
1183 break;
1184 case NBD_CMD_TRIM:
1185 TRACE("Request type is TRIM");
262db388
PB
1186 ret = bdrv_co_discard(exp->bs, (request.from + exp->dev_offset) / 512,
1187 request.len / 512);
7a706633
PB
1188 if (ret < 0) {
1189 LOG("discard failed");
1190 reply.error = -ret;
1191 }
fc19f8a0 1192 if (nbd_co_send_reply(req, &reply, 0) < 0) {
d9a73806 1193 goto out;
fc19f8a0 1194 }
1486d04a 1195 break;
b2e3d87f
NT
1196 default:
1197 LOG("invalid request type (%u) received", request.type);
fae69416
PB
1198 invalid_request:
1199 reply.error = -EINVAL;
1200 error_reply:
fc19f8a0 1201 if (nbd_co_send_reply(req, &reply, 0) < 0) {
d9a73806 1202 goto out;
fc19f8a0 1203 }
fae69416 1204 break;
b2e3d87f
NT
1205 }
1206
1207 TRACE("Request/Reply complete");
1208
7fe7b68b 1209done:
262db388
PB
1210 nbd_request_put(req);
1211 return;
1212
d9a73806 1213out:
72deddc5 1214 nbd_request_put(req);
262db388 1215 nbd_client_close(client);
7a5ca864 1216}
af49bbbe 1217
41996e38
PB
1218static int nbd_can_read(void *opaque)
1219{
1220 NBDClient *client = opaque;
1221
1222 return client->recv_coroutine || client->nb_requests < MAX_NBD_REQUESTS;
1223}
1224
1743b515
PB
1225static void nbd_read(void *opaque)
1226{
1227 NBDClient *client = opaque;
1228
262db388
PB
1229 if (client->recv_coroutine) {
1230 qemu_coroutine_enter(client->recv_coroutine, NULL);
1231 } else {
1232 qemu_coroutine_enter(qemu_coroutine_create(nbd_trip), client);
1743b515 1233 }
1743b515
PB
1234}
1235
262db388
PB
1236static void nbd_restart_write(void *opaque)
1237{
1238 NBDClient *client = opaque;
1239
1240 qemu_coroutine_enter(client->send_coroutine, NULL);
1241}
1242
1743b515
PB
1243NBDClient *nbd_client_new(NBDExport *exp, int csock,
1244 void (*close)(NBDClient *))
af49bbbe 1245{
1743b515 1246 NBDClient *client;
1743b515
PB
1247 client = g_malloc0(sizeof(NBDClient));
1248 client->refcount = 1;
1249 client->exp = exp;
1250 client->sock = csock;
9a304d29
PB
1251 if (nbd_send_negotiate(client) < 0) {
1252 g_free(client);
1253 return NULL;
1254 }
1743b515 1255 client->close = close;
262db388 1256 qemu_co_mutex_init(&client->send_lock);
41996e38 1257 qemu_set_fd_handler2(csock, nbd_can_read, nbd_read, NULL, client);
2c8d9f06 1258
6b8c01e7
PB
1259 if (exp) {
1260 QTAILQ_INSERT_TAIL(&exp->clients, client, next);
1261 nbd_export_get(exp);
1262 }
1743b515 1263 return client;
af49bbbe 1264}