]> git.proxmox.com Git - qemu.git/blame - nbd.c
Merge remote-tracking branch 'riku/linux-user-for-upstream' into staging
[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
FB
18
19#include "nbd.h"
ab359cd1 20#include "block.h"
7a5ca864 21
262db388
PB
22#include "qemu-coroutine.h"
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
03ff3ca3 39#include "qemu_socket.h"
d9a73806 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
b2e3d87f 60#define NBD_REPLY_SIZE (4 + 4 + 8)
7a5ca864
FB
61#define NBD_REQUEST_MAGIC 0x25609513
62#define NBD_REPLY_MAGIC 0x67446698
63
64#define NBD_SET_SOCK _IO(0xab, 0)
65#define NBD_SET_BLKSIZE _IO(0xab, 1)
66#define NBD_SET_SIZE _IO(0xab, 2)
67#define NBD_DO_IT _IO(0xab, 3)
68#define NBD_CLEAR_SOCK _IO(0xab, 4)
69#define NBD_CLEAR_QUE _IO(0xab, 5)
b2e3d87f
NT
70#define NBD_PRINT_DEBUG _IO(0xab, 6)
71#define NBD_SET_SIZE_BLOCKS _IO(0xab, 7)
7a5ca864 72#define NBD_DISCONNECT _IO(0xab, 8)
bbb74edd
PB
73#define NBD_SET_TIMEOUT _IO(0xab, 9)
74#define NBD_SET_FLAGS _IO(0xab, 10)
7a5ca864 75
b2e3d87f 76#define NBD_OPT_EXPORT_NAME (1 << 0)
1d45f8b5 77
7a5ca864
FB
78/* That's all folks */
79
185b4338 80ssize_t nbd_wr_sync(int fd, void *buffer, size_t size, bool do_read)
7a5ca864
FB
81{
82 size_t offset = 0;
185b4338 83 int err;
7a5ca864 84
ae255e52
PB
85 if (qemu_in_coroutine()) {
86 if (do_read) {
87 return qemu_co_recv(fd, buffer, size);
88 } else {
89 return qemu_co_send(fd, buffer, size);
90 }
91 }
92
7a5ca864
FB
93 while (offset < size) {
94 ssize_t len;
95
96 if (do_read) {
00aa0040 97 len = qemu_recv(fd, buffer + offset, size - offset, 0);
7a5ca864 98 } else {
03ff3ca3 99 len = send(fd, buffer + offset, size - offset, 0);
7a5ca864
FB
100 }
101
fc19f8a0 102 if (len < 0) {
185b4338 103 err = socket_error();
03ff3ca3 104
fc19f8a0 105 /* recoverable error */
7fe7b68b 106 if (err == EINTR || (offset > 0 && err == EAGAIN)) {
fc19f8a0
PB
107 continue;
108 }
109
110 /* unrecoverable error */
185b4338 111 return -err;
7a5ca864
FB
112 }
113
114 /* eof */
115 if (len == 0) {
116 break;
117 }
118
7a5ca864
FB
119 offset += len;
120 }
121
122 return offset;
123}
124
7fe7b68b
PB
125static ssize_t read_sync(int fd, void *buffer, size_t size)
126{
127 /* Sockets are kept in blocking mode in the negotiation phase. After
128 * that, a non-readable socket simply means that another thread stole
129 * our request/reply. Synchronization is done with recv_coroutine, so
130 * that this is coroutine-safe.
131 */
132 return nbd_wr_sync(fd, buffer, size, true);
133}
134
135static ssize_t write_sync(int fd, void *buffer, size_t size)
136{
137 int ret;
138 do {
139 /* For writes, we do expect the socket to be writable. */
140 ret = nbd_wr_sync(fd, buffer, size, false);
141 } while (ret == -EAGAIN);
142 return ret;
143}
144
c12504ce
NT
145static void combine_addr(char *buf, size_t len, const char* address,
146 uint16_t port)
7a5ca864 147{
c12504ce
NT
148 /* If the address-part contains a colon, it's an IPv6 IP so needs [] */
149 if (strstr(address, ":")) {
150 snprintf(buf, len, "[%s]:%u", address, port);
151 } else {
152 snprintf(buf, len, "%s:%u", address, port);
7a5ca864 153 }
7a5ca864
FB
154}
155
c12504ce 156int tcp_socket_outgoing(const char *address, uint16_t port)
7a5ca864 157{
c12504ce
NT
158 char address_and_port[128];
159 combine_addr(address_and_port, 128, address, port);
160 return tcp_socket_outgoing_spec(address_and_port);
7a5ca864
FB
161}
162
c12504ce 163int tcp_socket_outgoing_spec(const char *address_and_port)
cd831bd7 164{
c12504ce 165 return inet_connect(address_and_port, SOCK_STREAM);
cd831bd7
TS
166}
167
c12504ce 168int tcp_socket_incoming(const char *address, uint16_t port)
cd831bd7 169{
c12504ce
NT
170 char address_and_port[128];
171 combine_addr(address_and_port, 128, address, port);
172 return tcp_socket_incoming_spec(address_and_port);
173}
cd831bd7 174
c12504ce
NT
175int tcp_socket_incoming_spec(const char *address_and_port)
176{
177 char *ostr = NULL;
178 int olen = 0;
179 return inet_listen(address_and_port, ostr, olen, SOCK_STREAM, 0);
03ff3ca3 180}
c12504ce 181
03ff3ca3
AL
182int unix_socket_incoming(const char *path)
183{
c12504ce
NT
184 char *ostr = NULL;
185 int olen = 0;
186
187 return unix_listen(path, ostr, olen);
cd831bd7
TS
188}
189
03ff3ca3
AL
190int unix_socket_outgoing(const char *path)
191{
c12504ce 192 return unix_connect(path);
03ff3ca3 193}
cd831bd7 194
7a5ca864
FB
195/* Basic flow
196
197 Server Client
198
199 Negotiate
200 Request
201 Response
202 Request
203 Response
204 ...
205 ...
206 Request (type == 2)
207*/
208
af49bbbe 209static int nbd_send_negotiate(int csock, off_t size, uint32_t flags)
7a5ca864 210{
b2e3d87f 211 char buf[8 + 8 + 8 + 128];
185b4338 212 int rc;
b2e3d87f
NT
213
214 /* Negotiate
215 [ 0 .. 7] passwd ("NBDMAGIC")
216 [ 8 .. 15] magic (0x00420281861253)
217 [16 .. 23] size
b90fb4b8
PB
218 [24 .. 27] flags
219 [28 .. 151] reserved (0)
b2e3d87f
NT
220 */
221
7fe7b68b 222 socket_set_block(csock);
185b4338
PB
223 rc = -EINVAL;
224
b2e3d87f
NT
225 TRACE("Beginning negotiation.");
226 memcpy(buf, "NBDMAGIC", 8);
227 cpu_to_be64w((uint64_t*)(buf + 8), 0x00420281861253LL);
228 cpu_to_be64w((uint64_t*)(buf + 16), size);
2c7989a9 229 cpu_to_be32w((uint32_t*)(buf + 24),
7a706633
PB
230 flags | NBD_FLAG_HAS_FLAGS | NBD_FLAG_SEND_TRIM |
231 NBD_FLAG_SEND_FLUSH | NBD_FLAG_SEND_FUA);
b90fb4b8 232 memset(buf + 28, 0, 124);
b2e3d87f
NT
233
234 if (write_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
235 LOG("write failed");
185b4338 236 goto fail;
b2e3d87f
NT
237 }
238
07f35073 239 TRACE("Negotiation succeeded.");
185b4338
PB
240 rc = 0;
241fail:
7fe7b68b 242 socket_set_nonblock(csock);
185b4338 243 return rc;
7a5ca864
FB
244}
245
1d45f8b5
LV
246int nbd_receive_negotiate(int csock, const char *name, uint32_t *flags,
247 off_t *size, size_t *blocksize)
7a5ca864 248{
b2e3d87f
NT
249 char buf[256];
250 uint64_t magic, s;
251 uint16_t tmp;
185b4338 252 int rc;
b2e3d87f 253
07f35073 254 TRACE("Receiving negotiation.");
b2e3d87f 255
7fe7b68b 256 socket_set_block(csock);
185b4338
PB
257 rc = -EINVAL;
258
b2e3d87f
NT
259 if (read_sync(csock, buf, 8) != 8) {
260 LOG("read failed");
185b4338 261 goto fail;
b2e3d87f
NT
262 }
263
264 buf[8] = '\0';
265 if (strlen(buf) == 0) {
266 LOG("server connection closed");
185b4338 267 goto fail;
b2e3d87f
NT
268 }
269
270 TRACE("Magic is %c%c%c%c%c%c%c%c",
271 qemu_isprint(buf[0]) ? buf[0] : '.',
272 qemu_isprint(buf[1]) ? buf[1] : '.',
273 qemu_isprint(buf[2]) ? buf[2] : '.',
274 qemu_isprint(buf[3]) ? buf[3] : '.',
275 qemu_isprint(buf[4]) ? buf[4] : '.',
276 qemu_isprint(buf[5]) ? buf[5] : '.',
277 qemu_isprint(buf[6]) ? buf[6] : '.',
278 qemu_isprint(buf[7]) ? buf[7] : '.');
279
280 if (memcmp(buf, "NBDMAGIC", 8) != 0) {
281 LOG("Invalid magic received");
185b4338 282 goto fail;
b2e3d87f
NT
283 }
284
285 if (read_sync(csock, &magic, sizeof(magic)) != sizeof(magic)) {
286 LOG("read failed");
185b4338 287 goto fail;
b2e3d87f
NT
288 }
289 magic = be64_to_cpu(magic);
290 TRACE("Magic is 0x%" PRIx64, magic);
291
292 if (name) {
293 uint32_t reserved = 0;
294 uint32_t opt;
295 uint32_t namesize;
296
297 TRACE("Checking magic (opts_magic)");
298 if (magic != 0x49484156454F5054LL) {
299 LOG("Bad magic received");
185b4338 300 goto fail;
b2e3d87f
NT
301 }
302 if (read_sync(csock, &tmp, sizeof(tmp)) != sizeof(tmp)) {
303 LOG("flags read failed");
185b4338 304 goto fail;
b2e3d87f
NT
305 }
306 *flags = be16_to_cpu(tmp) << 16;
307 /* reserved for future use */
308 if (write_sync(csock, &reserved, sizeof(reserved)) !=
309 sizeof(reserved)) {
310 LOG("write failed (reserved)");
185b4338 311 goto fail;
b2e3d87f
NT
312 }
313 /* write the export name */
314 magic = cpu_to_be64(magic);
315 if (write_sync(csock, &magic, sizeof(magic)) != sizeof(magic)) {
316 LOG("write failed (magic)");
185b4338 317 goto fail;
b2e3d87f
NT
318 }
319 opt = cpu_to_be32(NBD_OPT_EXPORT_NAME);
320 if (write_sync(csock, &opt, sizeof(opt)) != sizeof(opt)) {
321 LOG("write failed (opt)");
185b4338 322 goto fail;
b2e3d87f
NT
323 }
324 namesize = cpu_to_be32(strlen(name));
325 if (write_sync(csock, &namesize, sizeof(namesize)) !=
326 sizeof(namesize)) {
327 LOG("write failed (namesize)");
185b4338 328 goto fail;
b2e3d87f
NT
329 }
330 if (write_sync(csock, (char*)name, strlen(name)) != strlen(name)) {
331 LOG("write failed (name)");
185b4338 332 goto fail;
b2e3d87f
NT
333 }
334 } else {
335 TRACE("Checking magic (cli_magic)");
336
337 if (magic != 0x00420281861253LL) {
338 LOG("Bad magic received");
185b4338 339 goto fail;
b2e3d87f
NT
340 }
341 }
342
343 if (read_sync(csock, &s, sizeof(s)) != sizeof(s)) {
344 LOG("read failed");
185b4338 345 goto fail;
b2e3d87f
NT
346 }
347 *size = be64_to_cpu(s);
348 *blocksize = 1024;
349 TRACE("Size is %" PRIu64, *size);
350
351 if (!name) {
352 if (read_sync(csock, flags, sizeof(*flags)) != sizeof(*flags)) {
353 LOG("read failed (flags)");
185b4338 354 goto fail;
b2e3d87f
NT
355 }
356 *flags = be32_to_cpup(flags);
357 } else {
358 if (read_sync(csock, &tmp, sizeof(tmp)) != sizeof(tmp)) {
359 LOG("read failed (tmp)");
185b4338 360 goto fail;
b2e3d87f
NT
361 }
362 *flags |= be32_to_cpu(tmp);
363 }
364 if (read_sync(csock, &buf, 124) != 124) {
365 LOG("read failed (buf)");
185b4338 366 goto fail;
b2e3d87f 367 }
185b4338
PB
368 rc = 0;
369
370fail:
7fe7b68b 371 socket_set_nonblock(csock);
185b4338 372 return rc;
cd831bd7 373}
7a5ca864 374
b90fb4b8
PB
375#ifdef __linux__
376int nbd_init(int fd, int csock, uint32_t flags, off_t size, size_t blocksize)
cd831bd7 377{
3e05c785
CL
378 TRACE("Setting NBD socket");
379
fc19f8a0 380 if (ioctl(fd, NBD_SET_SOCK, csock) < 0) {
3e05c785
CL
381 int serrno = errno;
382 LOG("Failed to set NBD socket");
185b4338 383 return -serrno;
3e05c785
CL
384 }
385
b2e3d87f 386 TRACE("Setting block size to %lu", (unsigned long)blocksize);
7a5ca864 387
fc19f8a0 388 if (ioctl(fd, NBD_SET_BLKSIZE, blocksize) < 0) {
b2e3d87f
NT
389 int serrno = errno;
390 LOG("Failed setting NBD block size");
185b4338 391 return -serrno;
b2e3d87f 392 }
7a5ca864 393
0bfcd599 394 TRACE("Setting size to %zd block(s)", (size_t)(size / blocksize));
7a5ca864 395
fc19f8a0 396 if (ioctl(fd, NBD_SET_SIZE_BLOCKS, size / blocksize) < 0) {
b2e3d87f
NT
397 int serrno = errno;
398 LOG("Failed setting size (in blocks)");
185b4338 399 return -serrno;
b2e3d87f 400 }
7a5ca864 401
b90fb4b8
PB
402 if (flags & NBD_FLAG_READ_ONLY) {
403 int read_only = 1;
404 TRACE("Setting readonly attribute");
405
406 if (ioctl(fd, BLKROSET, (unsigned long) &read_only) < 0) {
407 int serrno = errno;
408 LOG("Failed setting read-only attribute");
185b4338 409 return -serrno;
b90fb4b8
PB
410 }
411 }
412
973b3d0a
PB
413 if (ioctl(fd, NBD_SET_FLAGS, flags) < 0
414 && errno != ENOTTY) {
415 int serrno = errno;
416 LOG("Failed setting flags");
185b4338 417 return -serrno;
973b3d0a
PB
418 }
419
b2e3d87f 420 TRACE("Negotiation ended");
7a5ca864 421
b2e3d87f 422 return 0;
7a5ca864
FB
423}
424
425int nbd_disconnect(int fd)
426{
b2e3d87f
NT
427 ioctl(fd, NBD_CLEAR_QUE);
428 ioctl(fd, NBD_DISCONNECT);
429 ioctl(fd, NBD_CLEAR_SOCK);
430 return 0;
7a5ca864
FB
431}
432
0a4eb864 433int nbd_client(int fd)
7a5ca864 434{
b2e3d87f
NT
435 int ret;
436 int serrno;
7a5ca864 437
b2e3d87f 438 TRACE("Doing NBD loop");
7a5ca864 439
b2e3d87f 440 ret = ioctl(fd, NBD_DO_IT);
fc19f8a0 441 if (ret < 0 && errno == EPIPE) {
74624688
PB
442 /* NBD_DO_IT normally returns EPIPE when someone has disconnected
443 * the socket via NBD_DISCONNECT. We do not want to return 1 in
444 * that case.
445 */
446 ret = 0;
447 }
b2e3d87f 448 serrno = errno;
7a5ca864 449
b2e3d87f 450 TRACE("NBD loop returned %d: %s", ret, strerror(serrno));
7a5ca864 451
b2e3d87f
NT
452 TRACE("Clearing NBD queue");
453 ioctl(fd, NBD_CLEAR_QUE);
7a5ca864 454
b2e3d87f
NT
455 TRACE("Clearing NBD socket");
456 ioctl(fd, NBD_CLEAR_SOCK);
7a5ca864 457
b2e3d87f
NT
458 errno = serrno;
459 return ret;
7a5ca864 460}
03ff3ca3 461#else
8e72506e 462int nbd_init(int fd, int csock, uint32_t flags, off_t size, size_t blocksize)
03ff3ca3 463{
185b4338 464 return -ENOTSUP;
03ff3ca3
AL
465}
466
467int nbd_disconnect(int fd)
468{
185b4338 469 return -ENOTSUP;
03ff3ca3
AL
470}
471
0a4eb864 472int nbd_client(int fd)
03ff3ca3 473{
185b4338 474 return -ENOTSUP;
03ff3ca3
AL
475}
476#endif
7a5ca864 477
94e7340b 478ssize_t nbd_send_request(int csock, struct nbd_request *request)
7a5ca864 479{
b2e3d87f 480 uint8_t buf[4 + 4 + 8 + 8 + 4];
185b4338 481 ssize_t ret;
b2e3d87f
NT
482
483 cpu_to_be32w((uint32_t*)buf, NBD_REQUEST_MAGIC);
484 cpu_to_be32w((uint32_t*)(buf + 4), request->type);
485 cpu_to_be64w((uint64_t*)(buf + 8), request->handle);
486 cpu_to_be64w((uint64_t*)(buf + 16), request->from);
487 cpu_to_be32w((uint32_t*)(buf + 24), request->len);
75818250 488
b2e3d87f
NT
489 TRACE("Sending request to client: "
490 "{ .from = %" PRIu64", .len = %u, .handle = %" PRIu64", .type=%i}",
491 request->from, request->len, request->handle, request->type);
492
185b4338
PB
493 ret = write_sync(csock, buf, sizeof(buf));
494 if (ret < 0) {
495 return ret;
496 }
497
498 if (ret != sizeof(buf)) {
b2e3d87f 499 LOG("writing to socket failed");
185b4338 500 return -EINVAL;
b2e3d87f
NT
501 }
502 return 0;
503}
75818250 504
94e7340b 505static ssize_t nbd_receive_request(int csock, struct nbd_request *request)
75818250 506{
b2e3d87f
NT
507 uint8_t buf[4 + 4 + 8 + 8 + 4];
508 uint32_t magic;
185b4338 509 ssize_t ret;
b2e3d87f 510
185b4338
PB
511 ret = read_sync(csock, buf, sizeof(buf));
512 if (ret < 0) {
513 return ret;
514 }
515
516 if (ret != sizeof(buf)) {
b2e3d87f 517 LOG("read failed");
185b4338 518 return -EINVAL;
b2e3d87f
NT
519 }
520
521 /* Request
522 [ 0 .. 3] magic (NBD_REQUEST_MAGIC)
523 [ 4 .. 7] type (0 == READ, 1 == WRITE)
524 [ 8 .. 15] handle
525 [16 .. 23] from
526 [24 .. 27] len
527 */
528
529 magic = be32_to_cpup((uint32_t*)buf);
530 request->type = be32_to_cpup((uint32_t*)(buf + 4));
531 request->handle = be64_to_cpup((uint64_t*)(buf + 8));
532 request->from = be64_to_cpup((uint64_t*)(buf + 16));
533 request->len = be32_to_cpup((uint32_t*)(buf + 24));
534
535 TRACE("Got request: "
536 "{ magic = 0x%x, .type = %d, from = %" PRIu64" , len = %u }",
537 magic, request->type, request->from, request->len);
538
539 if (magic != NBD_REQUEST_MAGIC) {
540 LOG("invalid magic (got 0x%x)", magic);
185b4338 541 return -EINVAL;
b2e3d87f
NT
542 }
543 return 0;
75818250
TS
544}
545
94e7340b 546ssize_t nbd_receive_reply(int csock, struct nbd_reply *reply)
75818250 547{
b2e3d87f
NT
548 uint8_t buf[NBD_REPLY_SIZE];
549 uint32_t magic;
185b4338 550 ssize_t ret;
b2e3d87f 551
185b4338
PB
552 ret = read_sync(csock, buf, sizeof(buf));
553 if (ret < 0) {
554 return ret;
555 }
556
557 if (ret != sizeof(buf)) {
b2e3d87f 558 LOG("read failed");
185b4338 559 return -EINVAL;
b2e3d87f
NT
560 }
561
562 /* Reply
563 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
564 [ 4 .. 7] error (0 == no error)
565 [ 7 .. 15] handle
566 */
567
568 magic = be32_to_cpup((uint32_t*)buf);
569 reply->error = be32_to_cpup((uint32_t*)(buf + 4));
570 reply->handle = be64_to_cpup((uint64_t*)(buf + 8));
571
572 TRACE("Got reply: "
573 "{ magic = 0x%x, .error = %d, handle = %" PRIu64" }",
574 magic, reply->error, reply->handle);
575
576 if (magic != NBD_REPLY_MAGIC) {
577 LOG("invalid magic (got 0x%x)", magic);
185b4338 578 return -EINVAL;
b2e3d87f
NT
579 }
580 return 0;
75818250
TS
581}
582
94e7340b 583static ssize_t nbd_send_reply(int csock, struct nbd_reply *reply)
75818250 584{
b2e3d87f 585 uint8_t buf[4 + 4 + 8];
185b4338 586 ssize_t ret;
b2e3d87f
NT
587
588 /* Reply
589 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
590 [ 4 .. 7] error (0 == no error)
591 [ 7 .. 15] handle
592 */
593 cpu_to_be32w((uint32_t*)buf, NBD_REPLY_MAGIC);
594 cpu_to_be32w((uint32_t*)(buf + 4), reply->error);
595 cpu_to_be64w((uint64_t*)(buf + 8), reply->handle);
596
597 TRACE("Sending response to client");
598
185b4338
PB
599 ret = write_sync(csock, buf, sizeof(buf));
600 if (ret < 0) {
601 return ret;
602 }
603
604 if (ret != sizeof(buf)) {
b2e3d87f 605 LOG("writing to socket failed");
185b4338 606 return -EINVAL;
b2e3d87f
NT
607 }
608 return 0;
75818250 609}
7a5ca864 610
41996e38
PB
611#define MAX_NBD_REQUESTS 16
612
d9a73806
PB
613typedef struct NBDRequest NBDRequest;
614
615struct NBDRequest {
616 QSIMPLEQ_ENTRY(NBDRequest) entry;
72deddc5 617 NBDClient *client;
d9a73806
PB
618 uint8_t *data;
619};
620
af49bbbe
PB
621struct NBDExport {
622 BlockDriverState *bs;
623 off_t dev_offset;
624 off_t size;
af49bbbe 625 uint32_t nbdflags;
d9a73806 626 QSIMPLEQ_HEAD(, NBDRequest) requests;
af49bbbe
PB
627};
628
1743b515
PB
629struct NBDClient {
630 int refcount;
631 void (*close)(NBDClient *client);
632
633 NBDExport *exp;
634 int sock;
262db388
PB
635
636 Coroutine *recv_coroutine;
637
638 CoMutex send_lock;
639 Coroutine *send_coroutine;
41996e38
PB
640
641 int nb_requests;
1743b515
PB
642};
643
644static void nbd_client_get(NBDClient *client)
645{
646 client->refcount++;
647}
648
649static void nbd_client_put(NBDClient *client)
650{
651 if (--client->refcount == 0) {
652 g_free(client);
653 }
654}
655
656static void nbd_client_close(NBDClient *client)
657{
658 qemu_set_fd_handler2(client->sock, NULL, NULL, NULL, NULL);
659 close(client->sock);
660 client->sock = -1;
661 if (client->close) {
662 client->close(client);
663 }
664 nbd_client_put(client);
665}
666
72deddc5 667static NBDRequest *nbd_request_get(NBDClient *client)
d9a73806
PB
668{
669 NBDRequest *req;
72deddc5
PB
670 NBDExport *exp = client->exp;
671
41996e38
PB
672 assert(client->nb_requests <= MAX_NBD_REQUESTS - 1);
673 client->nb_requests++;
674
d9a73806
PB
675 if (QSIMPLEQ_EMPTY(&exp->requests)) {
676 req = g_malloc0(sizeof(NBDRequest));
677 req->data = qemu_blockalign(exp->bs, NBD_BUFFER_SIZE);
678 } else {
679 req = QSIMPLEQ_FIRST(&exp->requests);
680 QSIMPLEQ_REMOVE_HEAD(&exp->requests, entry);
681 }
72deddc5
PB
682 nbd_client_get(client);
683 req->client = client;
d9a73806
PB
684 return req;
685}
686
72deddc5 687static void nbd_request_put(NBDRequest *req)
d9a73806 688{
72deddc5
PB
689 NBDClient *client = req->client;
690 QSIMPLEQ_INSERT_HEAD(&client->exp->requests, req, entry);
41996e38
PB
691 if (client->nb_requests-- == MAX_NBD_REQUESTS) {
692 qemu_notify_event();
693 }
72deddc5 694 nbd_client_put(client);
d9a73806
PB
695}
696
af49bbbe
PB
697NBDExport *nbd_export_new(BlockDriverState *bs, off_t dev_offset,
698 off_t size, uint32_t nbdflags)
699{
700 NBDExport *exp = g_malloc0(sizeof(NBDExport));
d9a73806 701 QSIMPLEQ_INIT(&exp->requests);
af49bbbe
PB
702 exp->bs = bs;
703 exp->dev_offset = dev_offset;
704 exp->nbdflags = nbdflags;
38ceff04 705 exp->size = size == -1 ? bdrv_getlength(bs) : size;
af49bbbe
PB
706 return exp;
707}
708
709void nbd_export_close(NBDExport *exp)
710{
d9a73806
PB
711 while (!QSIMPLEQ_EMPTY(&exp->requests)) {
712 NBDRequest *first = QSIMPLEQ_FIRST(&exp->requests);
713 QSIMPLEQ_REMOVE_HEAD(&exp->requests, entry);
714 qemu_vfree(first->data);
715 g_free(first);
716 }
717
af49bbbe
PB
718 bdrv_close(exp->bs);
719 g_free(exp);
720}
721
41996e38 722static int nbd_can_read(void *opaque);
262db388
PB
723static void nbd_read(void *opaque);
724static void nbd_restart_write(void *opaque);
725
94e7340b
PB
726static ssize_t nbd_co_send_reply(NBDRequest *req, struct nbd_reply *reply,
727 int len)
22045592 728{
72deddc5
PB
729 NBDClient *client = req->client;
730 int csock = client->sock;
94e7340b 731 ssize_t rc, ret;
22045592 732
262db388 733 qemu_co_mutex_lock(&client->send_lock);
41996e38
PB
734 qemu_set_fd_handler2(csock, nbd_can_read, nbd_read,
735 nbd_restart_write, client);
262db388
PB
736 client->send_coroutine = qemu_coroutine_self();
737
22045592
PB
738 if (!len) {
739 rc = nbd_send_reply(csock, reply);
22045592
PB
740 } else {
741 socket_set_cork(csock, 1);
742 rc = nbd_send_reply(csock, reply);
fc19f8a0 743 if (rc >= 0) {
262db388 744 ret = qemu_co_send(csock, req->data, len);
22045592 745 if (ret != len) {
185b4338 746 rc = -EIO;
22045592
PB
747 }
748 }
22045592
PB
749 socket_set_cork(csock, 0);
750 }
262db388
PB
751
752 client->send_coroutine = NULL;
41996e38 753 qemu_set_fd_handler2(csock, nbd_can_read, nbd_read, NULL, client);
262db388 754 qemu_co_mutex_unlock(&client->send_lock);
22045592
PB
755 return rc;
756}
757
94e7340b 758static ssize_t nbd_co_receive_request(NBDRequest *req, struct nbd_request *request)
a030b347 759{
72deddc5
PB
760 NBDClient *client = req->client;
761 int csock = client->sock;
94e7340b 762 ssize_t rc;
a030b347 763
262db388 764 client->recv_coroutine = qemu_coroutine_self();
7fe7b68b
PB
765 rc = nbd_receive_request(csock, request);
766 if (rc < 0) {
767 if (rc != -EAGAIN) {
768 rc = -EIO;
769 }
a030b347
PB
770 goto out;
771 }
772
773 if (request->len > NBD_BUFFER_SIZE) {
774 LOG("len (%u) is larger than max len (%u)",
775 request->len, NBD_BUFFER_SIZE);
776 rc = -EINVAL;
777 goto out;
778 }
779
780 if ((request->from + request->len) < request->from) {
781 LOG("integer overflow detected! "
782 "you're probably being attacked");
783 rc = -EINVAL;
784 goto out;
785 }
786
787 TRACE("Decoding type");
788
789 if ((request->type & NBD_CMD_MASK_COMMAND) == NBD_CMD_WRITE) {
790 TRACE("Reading %u byte(s)", request->len);
791
262db388 792 if (qemu_co_recv(csock, req->data, request->len) != request->len) {
a030b347
PB
793 LOG("reading from socket failed");
794 rc = -EIO;
795 goto out;
796 }
797 }
798 rc = 0;
799
800out:
262db388 801 client->recv_coroutine = NULL;
a030b347
PB
802 return rc;
803}
804
262db388 805static void nbd_trip(void *opaque)
75818250 806{
262db388 807 NBDClient *client = opaque;
72deddc5 808 NBDRequest *req = nbd_request_get(client);
1743b515 809 NBDExport *exp = client->exp;
b2e3d87f
NT
810 struct nbd_request request;
811 struct nbd_reply reply;
94e7340b 812 ssize_t ret;
b2e3d87f
NT
813
814 TRACE("Reading request.");
815
262db388 816 ret = nbd_co_receive_request(req, &request);
7fe7b68b
PB
817 if (ret == -EAGAIN) {
818 goto done;
819 }
a030b347 820 if (ret == -EIO) {
d9a73806 821 goto out;
a030b347 822 }
b2e3d87f 823
fae69416
PB
824 reply.handle = request.handle;
825 reply.error = 0;
826
a030b347
PB
827 if (ret < 0) {
828 reply.error = -ret;
829 goto error_reply;
b2e3d87f
NT
830 }
831
af49bbbe 832 if ((request.from + request.len) > exp->size) {
b2e3d87f
NT
833 LOG("From: %" PRIu64 ", Len: %u, Size: %" PRIu64
834 ", Offset: %" PRIu64 "\n",
af49bbbe 835 request.from, request.len,
0fee8f34 836 (uint64_t)exp->size, (uint64_t)exp->dev_offset);
b2e3d87f 837 LOG("requested operation past EOF--bad client?");
fae69416 838 goto invalid_request;
b2e3d87f
NT
839 }
840
2c7989a9 841 switch (request.type & NBD_CMD_MASK_COMMAND) {
b2e3d87f
NT
842 case NBD_CMD_READ:
843 TRACE("Request type is READ");
844
e25ceb76
PB
845 if (request.type & NBD_CMD_FLAG_FUA) {
846 ret = bdrv_co_flush(exp->bs);
847 if (ret < 0) {
848 LOG("flush failed");
849 reply.error = -ret;
850 goto error_reply;
851 }
852 }
853
af49bbbe 854 ret = bdrv_read(exp->bs, (request.from + exp->dev_offset) / 512,
d9a73806 855 req->data, request.len / 512);
adcf6302 856 if (ret < 0) {
b2e3d87f 857 LOG("reading from file failed");
adcf6302 858 reply.error = -ret;
fae69416 859 goto error_reply;
b2e3d87f 860 }
b2e3d87f
NT
861
862 TRACE("Read %u byte(s)", request.len);
262db388 863 if (nbd_co_send_reply(req, &reply, request.len) < 0)
d9a73806 864 goto out;
b2e3d87f
NT
865 break;
866 case NBD_CMD_WRITE:
867 TRACE("Request type is WRITE");
868
af49bbbe 869 if (exp->nbdflags & NBD_FLAG_READ_ONLY) {
b2e3d87f 870 TRACE("Server is read-only, return error");
fae69416
PB
871 reply.error = EROFS;
872 goto error_reply;
873 }
874
875 TRACE("Writing to device");
876
af49bbbe 877 ret = bdrv_write(exp->bs, (request.from + exp->dev_offset) / 512,
d9a73806 878 req->data, request.len / 512);
fae69416
PB
879 if (ret < 0) {
880 LOG("writing to file failed");
881 reply.error = -ret;
882 goto error_reply;
883 }
b2e3d87f 884
fae69416 885 if (request.type & NBD_CMD_FLAG_FUA) {
262db388 886 ret = bdrv_co_flush(exp->bs);
adcf6302 887 if (ret < 0) {
fae69416 888 LOG("flush failed");
adcf6302 889 reply.error = -ret;
fae69416 890 goto error_reply;
2c7989a9 891 }
b2e3d87f
NT
892 }
893
fc19f8a0 894 if (nbd_co_send_reply(req, &reply, 0) < 0) {
d9a73806 895 goto out;
fc19f8a0 896 }
b2e3d87f
NT
897 break;
898 case NBD_CMD_DISC:
899 TRACE("Request type is DISCONNECT");
900 errno = 0;
262db388 901 goto out;
1486d04a
PB
902 case NBD_CMD_FLUSH:
903 TRACE("Request type is FLUSH");
904
262db388 905 ret = bdrv_co_flush(exp->bs);
1486d04a
PB
906 if (ret < 0) {
907 LOG("flush failed");
908 reply.error = -ret;
909 }
fc19f8a0 910 if (nbd_co_send_reply(req, &reply, 0) < 0) {
d9a73806 911 goto out;
fc19f8a0 912 }
7a706633
PB
913 break;
914 case NBD_CMD_TRIM:
915 TRACE("Request type is TRIM");
262db388
PB
916 ret = bdrv_co_discard(exp->bs, (request.from + exp->dev_offset) / 512,
917 request.len / 512);
7a706633
PB
918 if (ret < 0) {
919 LOG("discard failed");
920 reply.error = -ret;
921 }
fc19f8a0 922 if (nbd_co_send_reply(req, &reply, 0) < 0) {
d9a73806 923 goto out;
fc19f8a0 924 }
1486d04a 925 break;
b2e3d87f
NT
926 default:
927 LOG("invalid request type (%u) received", request.type);
fae69416
PB
928 invalid_request:
929 reply.error = -EINVAL;
930 error_reply:
fc19f8a0 931 if (nbd_co_send_reply(req, &reply, 0) < 0) {
d9a73806 932 goto out;
fc19f8a0 933 }
fae69416 934 break;
b2e3d87f
NT
935 }
936
937 TRACE("Request/Reply complete");
938
7fe7b68b 939done:
262db388
PB
940 nbd_request_put(req);
941 return;
942
d9a73806 943out:
72deddc5 944 nbd_request_put(req);
262db388 945 nbd_client_close(client);
7a5ca864 946}
af49bbbe 947
41996e38
PB
948static int nbd_can_read(void *opaque)
949{
950 NBDClient *client = opaque;
951
952 return client->recv_coroutine || client->nb_requests < MAX_NBD_REQUESTS;
953}
954
1743b515
PB
955static void nbd_read(void *opaque)
956{
957 NBDClient *client = opaque;
958
262db388
PB
959 if (client->recv_coroutine) {
960 qemu_coroutine_enter(client->recv_coroutine, NULL);
961 } else {
962 qemu_coroutine_enter(qemu_coroutine_create(nbd_trip), client);
1743b515 963 }
1743b515
PB
964}
965
262db388
PB
966static void nbd_restart_write(void *opaque)
967{
968 NBDClient *client = opaque;
969
970 qemu_coroutine_enter(client->send_coroutine, NULL);
971}
972
1743b515
PB
973NBDClient *nbd_client_new(NBDExport *exp, int csock,
974 void (*close)(NBDClient *))
af49bbbe 975{
1743b515 976 NBDClient *client;
fc19f8a0 977 if (nbd_send_negotiate(csock, exp->size, exp->nbdflags) < 0) {
1743b515
PB
978 return NULL;
979 }
980 client = g_malloc0(sizeof(NBDClient));
981 client->refcount = 1;
982 client->exp = exp;
983 client->sock = csock;
984 client->close = close;
262db388 985 qemu_co_mutex_init(&client->send_lock);
41996e38 986 qemu_set_fd_handler2(csock, nbd_can_read, nbd_read, NULL, client);
1743b515 987 return client;
af49bbbe 988}