2 * Copyright (C) 2005 Anthony Liguori <anthony@codemonkey.ws>
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/osdep.h"
20 #include "qemu-common.h"
21 #include "sysemu/block-backend.h"
22 #include "block/block_int.h"
23 #include "block/nbd.h"
24 #include "qemu/main-loop.h"
25 #include "qemu/error-report.h"
26 #include "qemu/config-file.h"
27 #include "block/snapshot.h"
28 #include "qapi/util.h"
29 #include "qapi/qmp/qstring.h"
30 #include "qom/object_interfaces.h"
31 #include "io/channel-socket.h"
34 #include <sys/types.h>
39 #define SOCKET_PATH "/var/lock/qemu-nbd-%s"
40 #define QEMU_NBD_OPT_CACHE 1
41 #define QEMU_NBD_OPT_AIO 2
42 #define QEMU_NBD_OPT_DISCARD 3
43 #define QEMU_NBD_OPT_DETECT_ZEROES 4
44 #define QEMU_NBD_OPT_OBJECT 5
46 static NBDExport *exp;
50 static SocketAddress *saddr;
51 static int persistent = 0;
52 static enum { RUNNING, TERMINATE, TERMINATING, TERMINATED } state;
53 static int shared = 1;
55 static QIOChannelSocket *server_ioc;
56 static int server_watch = -1;
58 static void usage(const char *name)
61 "Usage: %s [OPTIONS] FILE\n"
62 "QEMU Disk Network Block Device Server\n"
64 " -h, --help display this help and exit\n"
65 " -V, --version output version information and exit\n"
67 "Connection properties:\n"
68 " -p, --port=PORT port to listen on (default `%d')\n"
69 " -b, --bind=IFACE interface to bind to (default `0.0.0.0')\n"
70 " -k, --socket=PATH path to the unix socket\n"
71 " (default '"SOCKET_PATH"')\n"
72 " -e, --shared=NUM device can be shared by NUM clients (default '1')\n"
73 " -t, --persistent don't exit on the last connection\n"
74 " -v, --verbose display extra debugging information\n"
76 "Exposing part of the image:\n"
77 " -o, --offset=OFFSET offset into the image\n"
78 " -P, --partition=NUM only expose partition NUM\n"
80 "General purpose options:\n"
81 " --object type,id=ID,... define an object such as 'secret' for providing\n"
82 " passwords and/or encryption keys\n"
84 "Kernel NBD client support:\n"
85 " -c, --connect=DEV connect FILE to the local NBD device DEV\n"
86 " -d, --disconnect disconnect the specified device\n"
90 "Block device options:\n"
91 " -f, --format=FORMAT set image format (raw, qcow2, ...)\n"
92 " -r, --read-only export read-only\n"
93 " -s, --snapshot use FILE as an external snapshot, create a temporary\n"
94 " file with backing_file=FILE, redirect the write to\n"
95 " the temporary one\n"
96 " -l, --load-snapshot=SNAPSHOT_PARAM\n"
97 " load an internal snapshot inside FILE and export it\n"
98 " as an read-only device, SNAPSHOT_PARAM format is\n"
99 " 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
101 " -n, --nocache disable host cache\n"
102 " --cache=MODE set cache mode (none, writeback, ...)\n"
103 " --aio=MODE set AIO mode (native or threads)\n"
104 " --discard=MODE set discard mode (ignore, unmap)\n"
105 " --detect-zeroes=MODE set detect-zeroes mode (off, on, unmap)\n"
107 "Report bugs to <qemu-devel@nongnu.org>\n"
108 , name, NBD_DEFAULT_PORT, "DEVICE");
111 static void version(const char *name)
115 "Written by Anthony Liguori.\n"
117 "Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>.\n"
118 "This is free software; see the source for copying conditions. There is NO\n"
119 "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
123 struct partition_record
127 uint32_t start_cylinder;
128 uint8_t start_sector;
131 uint8_t end_cylinder;
133 uint32_t start_sector_abs;
134 uint32_t nb_sectors_abs;
137 static void read_partition(uint8_t *p, struct partition_record *r)
140 r->start_head = p[1];
141 r->start_cylinder = p[3] | ((p[2] << 2) & 0x0300);
142 r->start_sector = p[2] & 0x3f;
145 r->end_cylinder = p[7] | ((p[6] << 2) & 0x300);
146 r->end_sector = p[6] & 0x3f;
148 r->start_sector_abs = le32_to_cpup((uint32_t *)(p + 8));
149 r->nb_sectors_abs = le32_to_cpup((uint32_t *)(p + 12));
152 static int find_partition(BlockBackend *blk, int partition,
153 off_t *offset, off_t *size)
155 struct partition_record mbr[4];
161 if ((ret = blk_read(blk, 0, data, 1)) < 0) {
162 error_report("error while reading: %s", strerror(-ret));
166 if (data[510] != 0x55 || data[511] != 0xaa) {
170 for (i = 0; i < 4; i++) {
171 read_partition(&data[446 + 16 * i], &mbr[i]);
173 if (!mbr[i].system || !mbr[i].nb_sectors_abs) {
177 if (mbr[i].system == 0xF || mbr[i].system == 0x5) {
178 struct partition_record ext[4];
182 if ((ret = blk_read(blk, mbr[i].start_sector_abs, data1, 1)) < 0) {
183 error_report("error while reading: %s", strerror(-ret));
187 for (j = 0; j < 4; j++) {
188 read_partition(&data1[446 + 16 * j], &ext[j]);
189 if (!ext[j].system || !ext[j].nb_sectors_abs) {
193 if ((ext_partnum + j + 1) == partition) {
194 *offset = (uint64_t)ext[j].start_sector_abs << 9;
195 *size = (uint64_t)ext[j].nb_sectors_abs << 9;
200 } else if ((i + 1) == partition) {
201 *offset = (uint64_t)mbr[i].start_sector_abs << 9;
202 *size = (uint64_t)mbr[i].nb_sectors_abs << 9;
210 static void termsig_handler(int signum)
217 static void *show_parts(void *arg)
222 /* linux just needs an open() to trigger
223 * the partition table update
224 * but remember to load the module with max_part != 0 :
225 * modprobe nbd max_part=63
227 nbd = open(device, O_RDWR);
234 static void *nbd_client_thread(void *arg)
239 QIOChannelSocket *sioc;
242 pthread_t show_parts_thread;
243 Error *local_error = NULL;
245 sioc = qio_channel_socket_new();
246 if (qio_channel_socket_connect_sync(sioc,
249 error_report_err(local_error);
253 ret = nbd_receive_negotiate(QIO_CHANNEL(sioc), NULL, &nbdflags,
254 &size, &local_error);
257 error_report_err(local_error);
262 fd = open(device, O_RDWR);
264 /* Linux-only, we can use %m in printf. */
265 error_report("Failed to open %s: %m", device);
269 ret = nbd_init(fd, sioc, nbdflags, size);
274 /* update partition table */
275 pthread_create(&show_parts_thread, NULL, show_parts, device);
278 fprintf(stderr, "NBD device %s is now connected to %s\n",
281 /* Close stderr so that the qemu-nbd process exits. */
282 dup2(STDOUT_FILENO, STDERR_FILENO);
285 ret = nbd_client(fd);
290 object_unref(OBJECT(sioc));
291 kill(getpid(), SIGTERM);
292 return (void *) EXIT_SUCCESS;
297 object_unref(OBJECT(sioc));
299 kill(getpid(), SIGTERM);
300 return (void *) EXIT_FAILURE;
303 static int nbd_can_accept(void)
305 return nb_fds < shared;
308 static void nbd_export_closed(NBDExport *exp)
310 assert(state == TERMINATING);
314 static void nbd_update_server_watch(void);
316 static void nbd_client_closed(NBDClient *client)
319 if (nb_fds == 0 && !persistent && state == RUNNING) {
322 nbd_update_server_watch();
323 nbd_client_put(client);
326 static gboolean nbd_accept(QIOChannel *ioc, GIOCondition cond, gpointer opaque)
328 QIOChannelSocket *cioc;
330 cioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(ioc),
336 if (state >= TERMINATE) {
337 object_unref(OBJECT(cioc));
342 nbd_update_server_watch();
343 nbd_client_new(newproto ? NULL : exp, cioc, nbd_client_closed);
344 object_unref(OBJECT(cioc));
349 static void nbd_update_server_watch(void)
351 if (nbd_can_accept()) {
352 if (server_watch == -1) {
353 server_watch = qio_channel_add_watch(QIO_CHANNEL(server_ioc),
359 if (server_watch != -1) {
360 g_source_remove(server_watch);
367 static SocketAddress *nbd_build_socket_address(const char *sockpath,
371 SocketAddress *saddr;
373 saddr = g_new0(SocketAddress, 1);
375 saddr->type = SOCKET_ADDRESS_KIND_UNIX;
376 saddr->u.q_unix = g_new0(UnixSocketAddress, 1);
377 saddr->u.q_unix->path = g_strdup(sockpath);
379 saddr->type = SOCKET_ADDRESS_KIND_INET;
380 saddr->u.inet = g_new0(InetSocketAddress, 1);
381 saddr->u.inet->host = g_strdup(bindto);
383 saddr->u.inet->port = g_strdup(port);
385 saddr->u.inet->port = g_strdup_printf("%d", NBD_DEFAULT_PORT);
393 static QemuOptsList qemu_object_opts = {
395 .implied_opt_name = "qom-type",
396 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
403 int main(int argc, char **argv)
406 BlockDriverState *bs;
407 off_t dev_offset = 0;
408 uint32_t nbdflags = 0;
409 bool disconnect = false;
410 const char *bindto = "0.0.0.0";
411 const char *port = NULL;
412 char *sockpath = NULL;
415 QemuOpts *sn_opts = NULL;
416 const char *sn_id_or_name = NULL;
417 const char *sopt = "hVb:o:p:rsnP:c:dvk:e:f:tl:x:";
418 struct option lopt[] = {
419 { "help", 0, NULL, 'h' },
420 { "version", 0, NULL, 'V' },
421 { "bind", 1, NULL, 'b' },
422 { "port", 1, NULL, 'p' },
423 { "socket", 1, NULL, 'k' },
424 { "offset", 1, NULL, 'o' },
425 { "read-only", 0, NULL, 'r' },
426 { "partition", 1, NULL, 'P' },
427 { "connect", 1, NULL, 'c' },
428 { "disconnect", 0, NULL, 'd' },
429 { "snapshot", 0, NULL, 's' },
430 { "load-snapshot", 1, NULL, 'l' },
431 { "nocache", 0, NULL, 'n' },
432 { "cache", 1, NULL, QEMU_NBD_OPT_CACHE },
433 { "aio", 1, NULL, QEMU_NBD_OPT_AIO },
434 { "discard", 1, NULL, QEMU_NBD_OPT_DISCARD },
435 { "detect-zeroes", 1, NULL, QEMU_NBD_OPT_DETECT_ZEROES },
436 { "shared", 1, NULL, 'e' },
437 { "format", 1, NULL, 'f' },
438 { "persistent", 0, NULL, 't' },
439 { "verbose", 0, NULL, 'v' },
440 { "object", 1, NULL, QEMU_NBD_OPT_OBJECT },
441 { "export-name", 1, NULL, 'x' },
447 int flags = BDRV_O_RDWR;
450 bool seen_cache = false;
451 bool seen_discard = false;
452 bool seen_aio = false;
453 pthread_t client_thread;
454 const char *fmt = NULL;
455 Error *local_err = NULL;
456 BlockdevDetectZeroesOptions detect_zeroes = BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
457 QDict *options = NULL;
458 const char *export_name = NULL;
460 /* The client thread uses SIGTERM to interrupt the server. A signal
461 * handler ensures that "qemu-nbd -v -c" exits with a nice status code.
463 struct sigaction sa_sigterm;
464 memset(&sa_sigterm, 0, sizeof(sa_sigterm));
465 sa_sigterm.sa_handler = termsig_handler;
466 sigaction(SIGTERM, &sa_sigterm, NULL);
467 module_call_init(MODULE_INIT_QOM);
468 qemu_add_opts(&qemu_object_opts);
469 qemu_init_exec_dir(argv[0]);
471 while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
474 flags |= BDRV_O_SNAPSHOT;
477 optarg = (char *) "none";
479 case QEMU_NBD_OPT_CACHE:
481 error_report("-n and --cache can only be specified once");
485 if (bdrv_parse_cache_flags(optarg, &flags) == -1) {
486 error_report("Invalid cache mode `%s'", optarg);
490 case QEMU_NBD_OPT_AIO:
492 error_report("--aio can only be specified once");
496 if (!strcmp(optarg, "native")) {
497 flags |= BDRV_O_NATIVE_AIO;
498 } else if (!strcmp(optarg, "threads")) {
499 /* this is the default */
501 error_report("invalid aio mode `%s'", optarg);
505 case QEMU_NBD_OPT_DISCARD:
507 error_report("--discard can only be specified once");
511 if (bdrv_parse_discard_flags(optarg, &flags) == -1) {
512 error_report("Invalid discard mode `%s'", optarg);
516 case QEMU_NBD_OPT_DETECT_ZEROES:
518 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
520 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
521 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
524 error_reportf_err(local_err,
525 "Failed to parse detect_zeroes mode: ");
528 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
529 !(flags & BDRV_O_UNMAP)) {
530 error_report("setting detect-zeroes to unmap is not allowed "
531 "without setting discard operation to unmap");
542 dev_offset = strtoll (optarg, &end, 0);
544 error_report("Invalid offset `%s'", optarg);
547 if (dev_offset < 0) {
548 error_report("Offset must be positive `%s'", optarg);
553 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
554 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
557 error_report("Failed in parsing snapshot param `%s'",
562 sn_id_or_name = optarg;
566 nbdflags |= NBD_FLAG_READ_ONLY;
567 flags &= ~BDRV_O_RDWR;
570 partition = strtol(optarg, &end, 0);
572 error_report("Invalid partition `%s'", optarg);
575 if (partition < 1 || partition > 8) {
576 error_report("Invalid partition %d", partition);
582 if (sockpath[0] != '/') {
583 error_report("socket path must be absolute");
594 shared = strtol(optarg, &end, 0);
596 error_report("Invalid shared device number '%s'", optarg);
600 error_report("Shared device number must be greater than 0");
611 export_name = optarg;
625 error_report("Try `%s --help' for more information.", argv[0]);
627 case QEMU_NBD_OPT_OBJECT: {
629 opts = qemu_opts_parse_noisily(&qemu_object_opts,
638 if ((argc - optind) != 1) {
639 error_report("Invalid number of arguments");
640 error_printf("Try `%s --help' for more information.\n", argv[0]);
644 if (qemu_opts_foreach(&qemu_object_opts,
645 user_creatable_add_opts_foreach,
647 error_report_err(local_err);
652 int nbdfd = open(argv[optind], O_RDWR);
654 error_report("Cannot open %s: %s", argv[optind],
658 nbd_disconnect(nbdfd);
662 printf("%s disconnected\n", argv[optind]);
667 if (device && !verbose) {
672 if (qemu_pipe(stderr_fd) < 0) {
673 error_report("Error setting up communication pipe: %s",
678 /* Now daemonize, but keep a communication channel open to
679 * print errors and exit with the proper status code.
683 error_report("Failed to fork: %s", strerror(errno));
685 } else if (pid == 0) {
687 ret = qemu_daemon(1, 0);
689 /* Temporarily redirect stderr to the parent's pipe... */
690 dup2(stderr_fd[1], STDERR_FILENO);
692 error_report("Failed to daemonize: %s", strerror(errno));
696 /* ... close the descriptor we inherited and go on. */
702 /* In the parent. Print error messages from the child until
703 * it closes the pipe.
706 buf = g_malloc(1024);
707 while ((ret = read(stderr_fd[0], buf, 1024)) > 0) {
709 ret = qemu_write_full(STDERR_FILENO, buf, ret);
715 error_report("Cannot read from daemon: %s",
720 /* Usually the daemon should not print any message.
721 * Exit with zero status in that case.
727 if (device != NULL && sockpath == NULL) {
728 sockpath = g_malloc(128);
729 snprintf(sockpath, 128, SOCKET_PATH, basename(device));
732 saddr = nbd_build_socket_address(sockpath, bindto, port);
734 if (qemu_init_main_loop(&local_err)) {
735 error_report_err(local_err);
739 atexit(bdrv_close_all);
742 options = qdict_new();
743 qdict_put(options, "driver", qstring_from_str(fmt));
746 srcpath = argv[optind];
747 blk = blk_new_open("hda", srcpath, NULL, options, flags, &local_err);
749 error_reportf_err(local_err, "Failed to blk_new_open '%s': ",
756 ret = bdrv_snapshot_load_tmp(bs,
757 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
758 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
760 } else if (sn_id_or_name) {
761 ret = bdrv_snapshot_load_tmp_by_id_or_name(bs, sn_id_or_name,
765 error_reportf_err(local_err, "Failed to load snapshot: ");
769 bs->detect_zeroes = detect_zeroes;
770 fd_size = blk_getlength(blk);
772 error_report("Failed to determine the image length: %s",
777 if (partition != -1) {
778 ret = find_partition(blk, partition, &dev_offset, &fd_size);
780 error_report("Could not find partition %d: %s", partition,
786 exp = nbd_export_new(blk, dev_offset, fd_size, nbdflags, nbd_export_closed,
789 error_report_err(local_err);
793 nbd_export_set_name(exp, export_name);
797 server_ioc = qio_channel_socket_new();
798 if (qio_channel_socket_listen_sync(server_ioc, saddr, &local_err) < 0) {
799 object_unref(OBJECT(server_ioc));
800 error_report_err(local_err);
807 ret = pthread_create(&client_thread, NULL, nbd_client_thread, device);
809 error_report("Failed to create client thread: %s", strerror(ret));
813 /* Shut up GCC warnings. */
814 memset(&client_thread, 0, sizeof(client_thread));
817 nbd_update_server_watch();
819 /* now when the initialization is (almost) complete, chdir("/")
820 * to free any busy filesystems */
821 if (chdir("/") < 0) {
822 error_report("Could not chdir to root directory: %s",
829 main_loop_wait(false);
830 if (state == TERMINATE) {
832 nbd_export_close(exp);
836 } while (state != TERMINATED);
843 qemu_opts_del(sn_opts);
847 pthread_join(client_thread, &ret);