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/>.
25 #include <sys/ioctl.h>
27 #if defined(__sun__) || defined(__HAIKU__)
28 #include <sys/ioccom.h>
37 #include "qemu_socket.h"
42 #define TRACE(msg, ...) do { \
43 LOG(msg, ## __VA_ARGS__); \
46 #define TRACE(msg, ...) \
50 #define LOG(msg, ...) do { \
51 fprintf(stderr, "%s:%s():L%d: " msg "\n", \
52 __FILE__, __FUNCTION__, __LINE__, ## __VA_ARGS__); \
55 /* This is all part of the "official" NBD API */
57 #define NBD_REPLY_SIZE (4 + 4 + 8)
58 #define NBD_REQUEST_MAGIC 0x25609513
59 #define NBD_REPLY_MAGIC 0x67446698
61 #define NBD_SET_SOCK _IO(0xab, 0)
62 #define NBD_SET_BLKSIZE _IO(0xab, 1)
63 #define NBD_SET_SIZE _IO(0xab, 2)
64 #define NBD_DO_IT _IO(0xab, 3)
65 #define NBD_CLEAR_SOCK _IO(0xab, 4)
66 #define NBD_CLEAR_QUE _IO(0xab, 5)
67 #define NBD_PRINT_DEBUG _IO(0xab, 6)
68 #define NBD_SET_SIZE_BLOCKS _IO(0xab, 7)
69 #define NBD_DISCONNECT _IO(0xab, 8)
70 #define NBD_SET_TIMEOUT _IO(0xab, 9)
71 #define NBD_SET_FLAGS _IO(0xab, 10)
73 #define NBD_OPT_EXPORT_NAME (1 << 0)
75 /* That's all folks */
77 #define read_sync(fd, buffer, size) nbd_wr_sync(fd, buffer, size, true)
78 #define write_sync(fd, buffer, size) nbd_wr_sync(fd, buffer, size, false)
80 size_t nbd_wr_sync(int fd, void *buffer, size_t size, bool do_read)
84 if (qemu_in_coroutine()) {
86 return qemu_co_recv(fd, buffer, size);
88 return qemu_co_send(fd, buffer, size);
92 while (offset < size) {
96 len = qemu_recv(fd, buffer + offset, size - offset, 0);
98 len = send(fd, buffer + offset, size - offset, 0);
102 errno = socket_error();
104 /* recoverable error */
105 if (len == -1 && (errno == EAGAIN || errno == EINTR)) {
114 /* unrecoverable error */
125 static void combine_addr(char *buf, size_t len, const char* address,
128 /* If the address-part contains a colon, it's an IPv6 IP so needs [] */
129 if (strstr(address, ":")) {
130 snprintf(buf, len, "[%s]:%u", address, port);
132 snprintf(buf, len, "%s:%u", address, port);
136 int tcp_socket_outgoing(const char *address, uint16_t port)
138 char address_and_port[128];
139 combine_addr(address_and_port, 128, address, port);
140 return tcp_socket_outgoing_spec(address_and_port);
143 int tcp_socket_outgoing_spec(const char *address_and_port)
145 return inet_connect(address_and_port, SOCK_STREAM);
148 int tcp_socket_incoming(const char *address, uint16_t port)
150 char address_and_port[128];
151 combine_addr(address_and_port, 128, address, port);
152 return tcp_socket_incoming_spec(address_and_port);
155 int tcp_socket_incoming_spec(const char *address_and_port)
159 return inet_listen(address_and_port, ostr, olen, SOCK_STREAM, 0);
162 int unix_socket_incoming(const char *path)
167 return unix_listen(path, ostr, olen);
170 int unix_socket_outgoing(const char *path)
172 return unix_connect(path);
189 int nbd_negotiate(int csock, off_t size, uint32_t flags)
191 char buf[8 + 8 + 8 + 128];
194 [ 0 .. 7] passwd ("NBDMAGIC")
195 [ 8 .. 15] magic (0x00420281861253)
198 [28 .. 151] reserved (0)
201 TRACE("Beginning negotiation.");
202 memcpy(buf, "NBDMAGIC", 8);
203 cpu_to_be64w((uint64_t*)(buf + 8), 0x00420281861253LL);
204 cpu_to_be64w((uint64_t*)(buf + 16), size);
205 cpu_to_be32w((uint32_t*)(buf + 24), flags | NBD_FLAG_HAS_FLAGS);
206 memset(buf + 28, 0, 124);
208 if (write_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
214 TRACE("Negotiation succeeded.");
219 int nbd_receive_negotiate(int csock, const char *name, uint32_t *flags,
220 off_t *size, size_t *blocksize)
226 TRACE("Receiving negotiation.");
228 if (read_sync(csock, buf, 8) != 8) {
235 if (strlen(buf) == 0) {
236 LOG("server connection closed");
241 TRACE("Magic is %c%c%c%c%c%c%c%c",
242 qemu_isprint(buf[0]) ? buf[0] : '.',
243 qemu_isprint(buf[1]) ? buf[1] : '.',
244 qemu_isprint(buf[2]) ? buf[2] : '.',
245 qemu_isprint(buf[3]) ? buf[3] : '.',
246 qemu_isprint(buf[4]) ? buf[4] : '.',
247 qemu_isprint(buf[5]) ? buf[5] : '.',
248 qemu_isprint(buf[6]) ? buf[6] : '.',
249 qemu_isprint(buf[7]) ? buf[7] : '.');
251 if (memcmp(buf, "NBDMAGIC", 8) != 0) {
252 LOG("Invalid magic received");
257 if (read_sync(csock, &magic, sizeof(magic)) != sizeof(magic)) {
262 magic = be64_to_cpu(magic);
263 TRACE("Magic is 0x%" PRIx64, magic);
266 uint32_t reserved = 0;
270 TRACE("Checking magic (opts_magic)");
271 if (magic != 0x49484156454F5054LL) {
272 LOG("Bad magic received");
276 if (read_sync(csock, &tmp, sizeof(tmp)) != sizeof(tmp)) {
277 LOG("flags read failed");
281 *flags = be16_to_cpu(tmp) << 16;
282 /* reserved for future use */
283 if (write_sync(csock, &reserved, sizeof(reserved)) !=
285 LOG("write failed (reserved)");
289 /* write the export name */
290 magic = cpu_to_be64(magic);
291 if (write_sync(csock, &magic, sizeof(magic)) != sizeof(magic)) {
292 LOG("write failed (magic)");
296 opt = cpu_to_be32(NBD_OPT_EXPORT_NAME);
297 if (write_sync(csock, &opt, sizeof(opt)) != sizeof(opt)) {
298 LOG("write failed (opt)");
302 namesize = cpu_to_be32(strlen(name));
303 if (write_sync(csock, &namesize, sizeof(namesize)) !=
305 LOG("write failed (namesize)");
309 if (write_sync(csock, (char*)name, strlen(name)) != strlen(name)) {
310 LOG("write failed (name)");
315 TRACE("Checking magic (cli_magic)");
317 if (magic != 0x00420281861253LL) {
318 LOG("Bad magic received");
324 if (read_sync(csock, &s, sizeof(s)) != sizeof(s)) {
329 *size = be64_to_cpu(s);
331 TRACE("Size is %" PRIu64, *size);
334 if (read_sync(csock, flags, sizeof(*flags)) != sizeof(*flags)) {
335 LOG("read failed (flags)");
339 *flags = be32_to_cpup(flags);
341 if (read_sync(csock, &tmp, sizeof(tmp)) != sizeof(tmp)) {
342 LOG("read failed (tmp)");
346 *flags |= be32_to_cpu(tmp);
348 if (read_sync(csock, &buf, 124) != 124) {
349 LOG("read failed (buf)");
357 int nbd_init(int fd, int csock, uint32_t flags, off_t size, size_t blocksize)
359 TRACE("Setting block size to %lu", (unsigned long)blocksize);
361 if (ioctl(fd, NBD_SET_BLKSIZE, blocksize) == -1) {
363 LOG("Failed setting NBD block size");
368 TRACE("Setting size to %zd block(s)", (size_t)(size / blocksize));
370 if (ioctl(fd, NBD_SET_SIZE_BLOCKS, size / blocksize) == -1) {
372 LOG("Failed setting size (in blocks)");
377 if (flags & NBD_FLAG_READ_ONLY) {
379 TRACE("Setting readonly attribute");
381 if (ioctl(fd, BLKROSET, (unsigned long) &read_only) < 0) {
383 LOG("Failed setting read-only attribute");
389 if (ioctl(fd, NBD_SET_FLAGS, flags) < 0
390 && errno != ENOTTY) {
392 LOG("Failed setting flags");
397 TRACE("Clearing NBD socket");
399 if (ioctl(fd, NBD_CLEAR_SOCK) == -1) {
401 LOG("Failed clearing NBD socket");
406 TRACE("Setting NBD socket");
408 if (ioctl(fd, NBD_SET_SOCK, csock) == -1) {
410 LOG("Failed to set NBD socket");
415 TRACE("Negotiation ended");
420 int nbd_disconnect(int fd)
422 ioctl(fd, NBD_CLEAR_QUE);
423 ioctl(fd, NBD_DISCONNECT);
424 ioctl(fd, NBD_CLEAR_SOCK);
428 int nbd_client(int fd)
433 TRACE("Doing NBD loop");
435 ret = ioctl(fd, NBD_DO_IT);
436 if (ret == -1 && errno == EPIPE) {
437 /* NBD_DO_IT normally returns EPIPE when someone has disconnected
438 * the socket via NBD_DISCONNECT. We do not want to return 1 in
445 TRACE("NBD loop returned %d: %s", ret, strerror(serrno));
447 TRACE("Clearing NBD queue");
448 ioctl(fd, NBD_CLEAR_QUE);
450 TRACE("Clearing NBD socket");
451 ioctl(fd, NBD_CLEAR_SOCK);
457 int nbd_init(int fd, int csock, uint32_t flags, off_t size, size_t blocksize)
463 int nbd_disconnect(int fd)
469 int nbd_client(int fd)
476 int nbd_send_request(int csock, struct nbd_request *request)
478 uint8_t buf[4 + 4 + 8 + 8 + 4];
480 cpu_to_be32w((uint32_t*)buf, NBD_REQUEST_MAGIC);
481 cpu_to_be32w((uint32_t*)(buf + 4), request->type);
482 cpu_to_be64w((uint64_t*)(buf + 8), request->handle);
483 cpu_to_be64w((uint64_t*)(buf + 16), request->from);
484 cpu_to_be32w((uint32_t*)(buf + 24), request->len);
486 TRACE("Sending request to client: "
487 "{ .from = %" PRIu64", .len = %u, .handle = %" PRIu64", .type=%i}",
488 request->from, request->len, request->handle, request->type);
490 if (write_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
491 LOG("writing to socket failed");
498 static int nbd_receive_request(int csock, struct nbd_request *request)
500 uint8_t buf[4 + 4 + 8 + 8 + 4];
503 if (read_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
510 [ 0 .. 3] magic (NBD_REQUEST_MAGIC)
511 [ 4 .. 7] type (0 == READ, 1 == WRITE)
517 magic = be32_to_cpup((uint32_t*)buf);
518 request->type = be32_to_cpup((uint32_t*)(buf + 4));
519 request->handle = be64_to_cpup((uint64_t*)(buf + 8));
520 request->from = be64_to_cpup((uint64_t*)(buf + 16));
521 request->len = be32_to_cpup((uint32_t*)(buf + 24));
523 TRACE("Got request: "
524 "{ magic = 0x%x, .type = %d, from = %" PRIu64" , len = %u }",
525 magic, request->type, request->from, request->len);
527 if (magic != NBD_REQUEST_MAGIC) {
528 LOG("invalid magic (got 0x%x)", magic);
535 int nbd_receive_reply(int csock, struct nbd_reply *reply)
537 uint8_t buf[NBD_REPLY_SIZE];
540 memset(buf, 0xAA, sizeof(buf));
542 if (read_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
549 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
550 [ 4 .. 7] error (0 == no error)
554 magic = be32_to_cpup((uint32_t*)buf);
555 reply->error = be32_to_cpup((uint32_t*)(buf + 4));
556 reply->handle = be64_to_cpup((uint64_t*)(buf + 8));
559 "{ magic = 0x%x, .error = %d, handle = %" PRIu64" }",
560 magic, reply->error, reply->handle);
562 if (magic != NBD_REPLY_MAGIC) {
563 LOG("invalid magic (got 0x%x)", magic);
570 static int nbd_send_reply(int csock, struct nbd_reply *reply)
572 uint8_t buf[4 + 4 + 8];
575 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
576 [ 4 .. 7] error (0 == no error)
579 cpu_to_be32w((uint32_t*)buf, NBD_REPLY_MAGIC);
580 cpu_to_be32w((uint32_t*)(buf + 4), reply->error);
581 cpu_to_be64w((uint64_t*)(buf + 8), reply->handle);
583 TRACE("Sending response to client");
585 if (write_sync(csock, buf, sizeof(buf)) != sizeof(buf)) {
586 LOG("writing to socket failed");
593 int nbd_trip(BlockDriverState *bs, int csock, off_t size, uint64_t dev_offset,
594 off_t *offset, uint32_t nbdflags, uint8_t *data, int data_size)
596 struct nbd_request request;
597 struct nbd_reply reply;
600 TRACE("Reading request.");
602 if (nbd_receive_request(csock, &request) == -1)
605 if (request.len + NBD_REPLY_SIZE > data_size) {
606 LOG("len (%u) is larger than max len (%u)",
607 request.len + NBD_REPLY_SIZE, data_size);
612 if ((request.from + request.len) < request.from) {
613 LOG("integer overflow detected! "
614 "you're probably being attacked");
619 if ((request.from + request.len) > size) {
620 LOG("From: %" PRIu64 ", Len: %u, Size: %" PRIu64
621 ", Offset: %" PRIu64 "\n",
622 request.from, request.len, (uint64_t)size, dev_offset);
623 LOG("requested operation past EOF--bad client?");
628 TRACE("Decoding type");
630 reply.handle = request.handle;
633 switch (request.type) {
635 TRACE("Request type is READ");
637 ret = bdrv_read(bs, (request.from + dev_offset) / 512,
638 data + NBD_REPLY_SIZE,
641 LOG("reading from file failed");
645 *offset += request.len;
647 TRACE("Read %u byte(s)", request.len);
650 [ 0 .. 3] magic (NBD_REPLY_MAGIC)
651 [ 4 .. 7] error (0 == no error)
655 cpu_to_be32w((uint32_t*)data, NBD_REPLY_MAGIC);
656 cpu_to_be32w((uint32_t*)(data + 4), reply.error);
657 cpu_to_be64w((uint64_t*)(data + 8), reply.handle);
659 TRACE("Sending data to client");
661 if (write_sync(csock, data,
662 request.len + NBD_REPLY_SIZE) !=
663 request.len + NBD_REPLY_SIZE) {
664 LOG("writing to socket failed");
670 TRACE("Request type is WRITE");
672 TRACE("Reading %u byte(s)", request.len);
674 if (read_sync(csock, data, request.len) != request.len) {
675 LOG("reading from socket failed");
680 if (nbdflags & NBD_FLAG_READ_ONLY) {
681 TRACE("Server is read-only, return error");
684 TRACE("Writing to device");
686 ret = bdrv_write(bs, (request.from + dev_offset) / 512,
687 data, request.len / 512);
689 LOG("writing to file failed");
694 *offset += request.len;
697 if (nbd_send_reply(csock, &reply) == -1)
701 TRACE("Request type is DISCONNECT");
705 LOG("invalid request type (%u) received", request.type);
710 TRACE("Request/Reply complete");