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/>.
19 #include "qemu-common.h"
20 #include "sysemu/block-backend.h"
21 #include "block/block_int.h"
22 #include "block/nbd.h"
23 #include "qemu/main-loop.h"
24 #include "qemu/sockets.h"
25 #include "qemu/error-report.h"
26 #include "block/snapshot.h"
27 #include "qapi/util.h"
28 #include "qapi/qmp/qstring.h"
34 #include <sys/types.h>
35 #include <sys/socket.h>
36 #include <netinet/in.h>
37 #include <netinet/tcp.h>
38 #include <arpa/inet.h>
43 #define SOCKET_PATH "/var/lock/qemu-nbd-%s"
44 #define QEMU_NBD_OPT_CACHE 1
45 #define QEMU_NBD_OPT_AIO 2
46 #define QEMU_NBD_OPT_DISCARD 3
47 #define QEMU_NBD_OPT_DETECT_ZEROES 4
49 static NBDExport *exp;
52 static SocketAddress *saddr;
53 static int persistent = 0;
54 static enum { RUNNING, TERMINATE, TERMINATING, TERMINATED } state;
55 static int shared = 1;
59 static void usage(const char *name)
62 "Usage: %s [OPTIONS] FILE\n"
63 "QEMU Disk Network Block Device Server\n"
65 " -h, --help display this help and exit\n"
66 " -V, --version output version information and exit\n"
68 "Connection properties:\n"
69 " -p, --port=PORT port to listen on (default `%d')\n"
70 " -b, --bind=IFACE interface to bind to (default `0.0.0.0')\n"
71 " -k, --socket=PATH path to the unix socket\n"
72 " (default '"SOCKET_PATH"')\n"
73 " -e, --shared=NUM device can be shared by NUM clients (default '1')\n"
74 " -t, --persistent don't exit on the last connection\n"
75 " -v, --verbose display extra debugging information\n"
77 "Exposing part of the image:\n"
78 " -o, --offset=OFFSET offset into the image\n"
79 " -P, --partition=NUM only expose partition NUM\n"
82 "Kernel NBD client support:\n"
83 " -c, --connect=DEV connect FILE to the local NBD device DEV\n"
84 " -d, --disconnect disconnect the specified device\n"
88 "Block device options:\n"
89 " -f, --format=FORMAT set image format (raw, qcow2, ...)\n"
90 " -r, --read-only export read-only\n"
91 " -s, --snapshot use FILE as an external snapshot, create a temporary\n"
92 " file with backing_file=FILE, redirect the write to\n"
93 " the temporary one\n"
94 " -l, --load-snapshot=SNAPSHOT_PARAM\n"
95 " load an internal snapshot inside FILE and export it\n"
96 " as an read-only device, SNAPSHOT_PARAM format is\n"
97 " 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
99 " -n, --nocache disable host cache\n"
100 " --cache=MODE set cache mode (none, writeback, ...)\n"
101 " --aio=MODE set AIO mode (native or threads)\n"
102 " --discard=MODE set discard mode (ignore, unmap)\n"
103 " --detect-zeroes=MODE set detect-zeroes mode (off, on, unmap)\n"
106 , name, NBD_DEFAULT_PORT, "DEVICE");
109 static void version(const char *name)
113 "Written by Anthony Liguori.\n"
116 "This is free software; see the source for copying conditions. There is NO\n"
117 "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
121 struct partition_record
125 uint32_t start_cylinder;
126 uint8_t start_sector;
129 uint8_t end_cylinder;
131 uint32_t start_sector_abs;
132 uint32_t nb_sectors_abs;
135 static void read_partition(uint8_t *p, struct partition_record *r)
138 r->start_head = p[1];
139 r->start_cylinder = p[3] | ((p[2] << 2) & 0x0300);
140 r->start_sector = p[2] & 0x3f;
143 r->end_cylinder = p[7] | ((p[6] << 2) & 0x300);
144 r->end_sector = p[6] & 0x3f;
146 r->start_sector_abs = le32_to_cpup((uint32_t *)(p + 8));
147 r->nb_sectors_abs = le32_to_cpup((uint32_t *)(p + 12));
150 static int find_partition(BlockBackend *blk, int partition,
151 off_t *offset, off_t *size)
153 struct partition_record mbr[4];
159 if ((ret = blk_read(blk, 0, data, 1)) < 0) {
161 err(EXIT_FAILURE, "error while reading");
164 if (data[510] != 0x55 || data[511] != 0xaa) {
168 for (i = 0; i < 4; i++) {
169 read_partition(&data[446 + 16 * i], &mbr[i]);
171 if (!mbr[i].system || !mbr[i].nb_sectors_abs) {
175 if (mbr[i].system == 0xF || mbr[i].system == 0x5) {
176 struct partition_record ext[4];
180 if ((ret = blk_read(blk, mbr[i].start_sector_abs, data1, 1)) < 0) {
182 err(EXIT_FAILURE, "error while reading");
185 for (j = 0; j < 4; j++) {
186 read_partition(&data1[446 + 16 * j], &ext[j]);
187 if (!ext[j].system || !ext[j].nb_sectors_abs) {
191 if ((ext_partnum + j + 1) == partition) {
192 *offset = (uint64_t)ext[j].start_sector_abs << 9;
193 *size = (uint64_t)ext[j].nb_sectors_abs << 9;
198 } else if ((i + 1) == partition) {
199 *offset = (uint64_t)mbr[i].start_sector_abs << 9;
200 *size = (uint64_t)mbr[i].nb_sectors_abs << 9;
208 static void termsig_handler(int signum)
215 static void *show_parts(void *arg)
220 /* linux just needs an open() to trigger
221 * the partition table update
222 * but remember to load the module with max_part != 0 :
223 * modprobe nbd max_part=63
225 nbd = open(device, O_RDWR);
232 static void *nbd_client_thread(void *arg)
239 pthread_t show_parts_thread;
240 Error *local_error = NULL;
243 sock = socket_connect(saddr, &local_error, NULL, NULL);
245 error_report_err(local_error);
249 ret = nbd_receive_negotiate(sock, NULL, &nbdflags,
250 &size, &local_error);
253 fprintf(stderr, "%s\n", error_get_pretty(local_error));
254 error_free(local_error);
259 fd = open(device, O_RDWR);
261 /* Linux-only, we can use %m in printf. */
262 fprintf(stderr, "Failed to open %s: %m\n", device);
266 ret = nbd_init(fd, sock, nbdflags, size);
271 /* update partition table */
272 pthread_create(&show_parts_thread, NULL, show_parts, device);
275 fprintf(stderr, "NBD device %s is now connected to %s\n",
278 /* Close stderr so that the qemu-nbd process exits. */
279 dup2(STDOUT_FILENO, STDERR_FILENO);
282 ret = nbd_client(fd);
287 kill(getpid(), SIGTERM);
288 return (void *) EXIT_SUCCESS;
295 kill(getpid(), SIGTERM);
296 return (void *) EXIT_FAILURE;
299 static int nbd_can_accept(void)
301 return nb_fds < shared;
304 static void nbd_export_closed(NBDExport *exp)
306 assert(state == TERMINATING);
310 static void nbd_update_server_fd_handler(int fd);
312 static void nbd_client_closed(NBDClient *client)
315 if (nb_fds == 0 && !persistent && state == RUNNING) {
318 nbd_update_server_fd_handler(server_fd);
319 nbd_client_put(client);
322 static void nbd_accept(void *opaque)
324 struct sockaddr_in addr;
325 socklen_t addr_len = sizeof(addr);
327 int fd = accept(server_fd, (struct sockaddr *)&addr, &addr_len);
333 if (state >= TERMINATE) {
338 if (nbd_client_new(exp, fd, nbd_client_closed)) {
340 nbd_update_server_fd_handler(server_fd);
347 static void nbd_update_server_fd_handler(int fd)
349 if (nbd_can_accept()) {
350 qemu_set_fd_handler(fd, nbd_accept, NULL, (void *)(uintptr_t)fd);
352 qemu_set_fd_handler(fd, NULL, NULL, NULL);
357 static SocketAddress *nbd_build_socket_address(const char *sockpath,
361 SocketAddress *saddr;
363 saddr = g_new0(SocketAddress, 1);
365 saddr->kind = SOCKET_ADDRESS_KIND_UNIX;
366 saddr->q_unix = g_new0(UnixSocketAddress, 1);
367 saddr->q_unix->path = g_strdup(sockpath);
369 saddr->kind = SOCKET_ADDRESS_KIND_INET;
370 saddr->inet = g_new0(InetSocketAddress, 1);
371 saddr->inet->host = g_strdup(bindto);
373 saddr->inet->port = g_strdup(port);
375 saddr->inet->port = g_strdup_printf("%d", NBD_DEFAULT_PORT);
383 int main(int argc, char **argv)
386 BlockDriverState *bs;
387 off_t dev_offset = 0;
388 uint32_t nbdflags = 0;
389 bool disconnect = false;
390 const char *bindto = "0.0.0.0";
391 const char *port = NULL;
392 char *sockpath = NULL;
395 QemuOpts *sn_opts = NULL;
396 const char *sn_id_or_name = NULL;
397 const char *sopt = "hVb:o:p:rsnP:c:dvk:e:f:tl:";
398 struct option lopt[] = {
399 { "help", 0, NULL, 'h' },
400 { "version", 0, NULL, 'V' },
401 { "bind", 1, NULL, 'b' },
402 { "port", 1, NULL, 'p' },
403 { "socket", 1, NULL, 'k' },
404 { "offset", 1, NULL, 'o' },
405 { "read-only", 0, NULL, 'r' },
406 { "partition", 1, NULL, 'P' },
407 { "connect", 1, NULL, 'c' },
408 { "disconnect", 0, NULL, 'd' },
409 { "snapshot", 0, NULL, 's' },
410 { "load-snapshot", 1, NULL, 'l' },
411 { "nocache", 0, NULL, 'n' },
412 { "cache", 1, NULL, QEMU_NBD_OPT_CACHE },
413 { "aio", 1, NULL, QEMU_NBD_OPT_AIO },
414 { "discard", 1, NULL, QEMU_NBD_OPT_DISCARD },
415 { "detect-zeroes", 1, NULL, QEMU_NBD_OPT_DETECT_ZEROES },
416 { "shared", 1, NULL, 'e' },
417 { "format", 1, NULL, 'f' },
418 { "persistent", 0, NULL, 't' },
419 { "verbose", 0, NULL, 'v' },
425 int flags = BDRV_O_RDWR;
429 bool seen_cache = false;
430 bool seen_discard = false;
431 bool seen_aio = false;
432 pthread_t client_thread;
433 const char *fmt = NULL;
434 Error *local_err = NULL;
435 BlockdevDetectZeroesOptions detect_zeroes = BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
436 QDict *options = NULL;
438 /* The client thread uses SIGTERM to interrupt the server. A signal
439 * handler ensures that "qemu-nbd -v -c" exits with a nice status code.
441 struct sigaction sa_sigterm;
442 memset(&sa_sigterm, 0, sizeof(sa_sigterm));
443 sa_sigterm.sa_handler = termsig_handler;
444 sigaction(SIGTERM, &sa_sigterm, NULL);
445 qemu_init_exec_dir(argv[0]);
447 while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
450 flags |= BDRV_O_SNAPSHOT;
453 optarg = (char *) "none";
455 case QEMU_NBD_OPT_CACHE:
457 errx(EXIT_FAILURE, "-n and --cache can only be specified once");
460 if (bdrv_parse_cache_flags(optarg, &flags) == -1) {
461 errx(EXIT_FAILURE, "Invalid cache mode `%s'", optarg);
464 case QEMU_NBD_OPT_AIO:
466 errx(EXIT_FAILURE, "--aio can only be specified once");
469 if (!strcmp(optarg, "native")) {
470 flags |= BDRV_O_NATIVE_AIO;
471 } else if (!strcmp(optarg, "threads")) {
472 /* this is the default */
474 errx(EXIT_FAILURE, "invalid aio mode `%s'", optarg);
477 case QEMU_NBD_OPT_DISCARD:
479 errx(EXIT_FAILURE, "--discard can only be specified once");
482 if (bdrv_parse_discard_flags(optarg, &flags) == -1) {
483 errx(EXIT_FAILURE, "Invalid discard mode `%s'", optarg);
486 case QEMU_NBD_OPT_DETECT_ZEROES:
488 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
490 BLOCKDEV_DETECT_ZEROES_OPTIONS_MAX,
491 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
494 errx(EXIT_FAILURE, "Failed to parse detect_zeroes mode: %s",
495 error_get_pretty(local_err));
497 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
498 !(flags & BDRV_O_UNMAP)) {
499 errx(EXIT_FAILURE, "setting detect-zeroes to unmap is not allowed "
500 "without setting discard operation to unmap");
510 dev_offset = strtoll (optarg, &end, 0);
512 errx(EXIT_FAILURE, "Invalid offset `%s'", optarg);
514 if (dev_offset < 0) {
515 errx(EXIT_FAILURE, "Offset must be positive `%s'", optarg);
519 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
520 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
523 errx(EXIT_FAILURE, "Failed in parsing snapshot param `%s'",
527 sn_id_or_name = optarg;
531 nbdflags |= NBD_FLAG_READ_ONLY;
532 flags &= ~BDRV_O_RDWR;
535 partition = strtol(optarg, &end, 0);
537 errx(EXIT_FAILURE, "Invalid partition `%s'", optarg);
539 if (partition < 1 || partition > 8) {
540 errx(EXIT_FAILURE, "Invalid partition %d", partition);
545 if (sockpath[0] != '/') {
546 errx(EXIT_FAILURE, "socket path must be absolute\n");
556 shared = strtol(optarg, &end, 0);
558 errx(EXIT_FAILURE, "Invalid shared device number '%s'", optarg);
561 errx(EXIT_FAILURE, "Shared device number must be greater than 0\n");
582 errx(EXIT_FAILURE, "Try `%s --help' for more information.",
587 if ((argc - optind) != 1) {
588 errx(EXIT_FAILURE, "Invalid number of argument.\n"
589 "Try `%s --help' for more information.",
594 fd = open(argv[optind], O_RDWR);
596 err(EXIT_FAILURE, "Cannot open %s", argv[optind]);
602 printf("%s disconnected\n", argv[optind]);
607 if (device && !verbose) {
612 if (qemu_pipe(stderr_fd) < 0) {
613 err(EXIT_FAILURE, "Error setting up communication pipe");
616 /* Now daemonize, but keep a communication channel open to
617 * print errors and exit with the proper status code.
621 err(EXIT_FAILURE, "Failed to fork");
622 } else if (pid == 0) {
624 ret = qemu_daemon(1, 0);
626 /* Temporarily redirect stderr to the parent's pipe... */
627 dup2(stderr_fd[1], STDERR_FILENO);
629 err(EXIT_FAILURE, "Failed to daemonize");
632 /* ... close the descriptor we inherited and go on. */
638 /* In the parent. Print error messages from the child until
639 * it closes the pipe.
642 buf = g_malloc(1024);
643 while ((ret = read(stderr_fd[0], buf, 1024)) > 0) {
645 ret = qemu_write_full(STDERR_FILENO, buf, ret);
651 err(EXIT_FAILURE, "Cannot read from daemon");
654 /* Usually the daemon should not print any message.
655 * Exit with zero status in that case.
661 if (device != NULL && sockpath == NULL) {
662 sockpath = g_malloc(128);
663 snprintf(sockpath, 128, SOCKET_PATH, basename(device));
666 saddr = nbd_build_socket_address(sockpath, bindto, port);
668 if (qemu_init_main_loop(&local_err)) {
669 error_report_err(local_err);
673 atexit(bdrv_close_all);
676 options = qdict_new();
677 qdict_put(options, "driver", qstring_from_str(fmt));
680 srcpath = argv[optind];
681 blk = blk_new_open("hda", srcpath, NULL, options, flags, &local_err);
683 errx(EXIT_FAILURE, "Failed to blk_new_open '%s': %s", argv[optind],
684 error_get_pretty(local_err));
689 ret = bdrv_snapshot_load_tmp(bs,
690 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
691 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
693 } else if (sn_id_or_name) {
694 ret = bdrv_snapshot_load_tmp_by_id_or_name(bs, sn_id_or_name,
700 "Failed to load snapshot: %s",
701 error_get_pretty(local_err));
704 bs->detect_zeroes = detect_zeroes;
705 fd_size = blk_getlength(blk);
707 errx(EXIT_FAILURE, "Failed to determine the image length: %s",
711 if (partition != -1) {
712 ret = find_partition(blk, partition, &dev_offset, &fd_size);
715 err(EXIT_FAILURE, "Could not find partition %d", partition);
719 exp = nbd_export_new(blk, dev_offset, fd_size, nbdflags, nbd_export_closed,
722 errx(EXIT_FAILURE, "%s", error_get_pretty(local_err));
725 fd = socket_listen(saddr, &local_err);
727 error_report_err(local_err);
734 ret = pthread_create(&client_thread, NULL, nbd_client_thread, device);
736 errx(EXIT_FAILURE, "Failed to create client thread: %s",
740 /* Shut up GCC warnings. */
741 memset(&client_thread, 0, sizeof(client_thread));
745 nbd_update_server_fd_handler(fd);
747 /* now when the initialization is (almost) complete, chdir("/")
748 * to free any busy filesystems */
749 if (chdir("/") < 0) {
750 err(EXIT_FAILURE, "Could not chdir to root directory");
755 main_loop_wait(false);
756 if (state == TERMINATE) {
758 nbd_export_close(exp);
762 } while (state != TERMINATED);
769 qemu_opts_del(sn_opts);
773 pthread_join(client_thread, &ret);