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 "qapi/error.h"
21 #include "qemu-common.h"
22 #include "qemu/cutils.h"
23 #include "sysemu/block-backend.h"
24 #include "block/block_int.h"
25 #include "block/nbd.h"
26 #include "qemu/main-loop.h"
27 #include "qemu/error-report.h"
28 #include "qemu/config-file.h"
29 #include "qemu/bswap.h"
30 #include "block/snapshot.h"
31 #include "qapi/util.h"
32 #include "qapi/qmp/qstring.h"
33 #include "qom/object_interfaces.h"
34 #include "io/channel-socket.h"
35 #include "crypto/init.h"
41 #define SOCKET_PATH "/var/lock/qemu-nbd-%s"
42 #define QEMU_NBD_OPT_CACHE 256
43 #define QEMU_NBD_OPT_AIO 257
44 #define QEMU_NBD_OPT_DISCARD 258
45 #define QEMU_NBD_OPT_DETECT_ZEROES 259
46 #define QEMU_NBD_OPT_OBJECT 260
47 #define QEMU_NBD_OPT_TLSCREDS 261
48 #define QEMU_NBD_OPT_IMAGE_OPTS 262
52 static NBDExport *exp;
56 static SocketAddress *saddr;
57 static int persistent = 0;
58 static enum { RUNNING, TERMINATE, TERMINATING, TERMINATED } state;
59 static int shared = 1;
61 static QIOChannelSocket *server_ioc;
62 static int server_watch = -1;
63 static QCryptoTLSCreds *tlscreds;
65 static void usage(const char *name)
68 "Usage: %s [OPTIONS] FILE\n"
69 "QEMU Disk Network Block Device Server\n"
71 " -h, --help display this help and exit\n"
72 " -V, --version output version information and exit\n"
74 "Connection properties:\n"
75 " -p, --port=PORT port to listen on (default `%d')\n"
76 " -b, --bind=IFACE interface to bind to (default `0.0.0.0')\n"
77 " -k, --socket=PATH path to the unix socket\n"
78 " (default '"SOCKET_PATH"')\n"
79 " -e, --shared=NUM device can be shared by NUM clients (default '1')\n"
80 " -t, --persistent don't exit on the last connection\n"
81 " -v, --verbose display extra debugging information\n"
82 " -x, --export-name=NAME expose export by name\n"
84 "Exposing part of the image:\n"
85 " -o, --offset=OFFSET offset into the image\n"
86 " -P, --partition=NUM only expose partition NUM\n"
88 "General purpose options:\n"
89 " --object type,id=ID,... define an object such as 'secret' for providing\n"
90 " passwords and/or encryption keys\n"
92 "Kernel NBD client support:\n"
93 " -c, --connect=DEV connect FILE to the local NBD device DEV\n"
94 " -d, --disconnect disconnect the specified device\n"
98 "Block device options:\n"
99 " -f, --format=FORMAT set image format (raw, qcow2, ...)\n"
100 " -r, --read-only export read-only\n"
101 " -s, --snapshot use FILE as an external snapshot, create a temporary\n"
102 " file with backing_file=FILE, redirect the write to\n"
103 " the temporary one\n"
104 " -l, --load-snapshot=SNAPSHOT_PARAM\n"
105 " load an internal snapshot inside FILE and export it\n"
106 " as an read-only device, SNAPSHOT_PARAM format is\n"
107 " 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
109 " -n, --nocache disable host cache\n"
110 " --cache=MODE set cache mode (none, writeback, ...)\n"
111 " --aio=MODE set AIO mode (native or threads)\n"
112 " --discard=MODE set discard mode (ignore, unmap)\n"
113 " --detect-zeroes=MODE set detect-zeroes mode (off, on, unmap)\n"
114 " --image-opts treat FILE as a full set of image options\n"
117 , name, NBD_DEFAULT_PORT, "DEVICE");
120 static void version(const char *name)
124 "Written by Anthony Liguori.\n"
127 "This is free software; see the source for copying conditions. There is NO\n"
128 "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
132 struct partition_record
136 uint32_t start_cylinder;
137 uint8_t start_sector;
140 uint8_t end_cylinder;
142 uint32_t start_sector_abs;
143 uint32_t nb_sectors_abs;
146 static void read_partition(uint8_t *p, struct partition_record *r)
149 r->start_head = p[1];
150 r->start_cylinder = p[3] | ((p[2] << 2) & 0x0300);
151 r->start_sector = p[2] & 0x3f;
154 r->end_cylinder = p[7] | ((p[6] << 2) & 0x300);
155 r->end_sector = p[6] & 0x3f;
157 r->start_sector_abs = le32_to_cpup((uint32_t *)(p + 8));
158 r->nb_sectors_abs = le32_to_cpup((uint32_t *)(p + 12));
161 static int find_partition(BlockBackend *blk, int partition,
162 off_t *offset, off_t *size)
164 struct partition_record mbr[4];
165 uint8_t data[MBR_SIZE];
170 ret = blk_pread(blk, 0, data, sizeof(data));
172 error_report("error while reading: %s", strerror(-ret));
176 if (data[510] != 0x55 || data[511] != 0xaa) {
180 for (i = 0; i < 4; i++) {
181 read_partition(&data[446 + 16 * i], &mbr[i]);
183 if (!mbr[i].system || !mbr[i].nb_sectors_abs) {
187 if (mbr[i].system == 0xF || mbr[i].system == 0x5) {
188 struct partition_record ext[4];
189 uint8_t data1[MBR_SIZE];
192 ret = blk_pread(blk, mbr[i].start_sector_abs * MBR_SIZE,
193 data1, sizeof(data1));
195 error_report("error while reading: %s", strerror(-ret));
199 for (j = 0; j < 4; j++) {
200 read_partition(&data1[446 + 16 * j], &ext[j]);
201 if (!ext[j].system || !ext[j].nb_sectors_abs) {
205 if ((ext_partnum + j + 1) == partition) {
206 *offset = (uint64_t)ext[j].start_sector_abs << 9;
207 *size = (uint64_t)ext[j].nb_sectors_abs << 9;
212 } else if ((i + 1) == partition) {
213 *offset = (uint64_t)mbr[i].start_sector_abs << 9;
214 *size = (uint64_t)mbr[i].nb_sectors_abs << 9;
222 static void termsig_handler(int signum)
224 atomic_cmpxchg(&state, RUNNING, TERMINATE);
229 static void *show_parts(void *arg)
234 /* linux just needs an open() to trigger
235 * the partition table update
236 * but remember to load the module with max_part != 0 :
237 * modprobe nbd max_part=63
239 nbd = open(device, O_RDWR);
246 static void *nbd_client_thread(void *arg)
251 QIOChannelSocket *sioc;
254 pthread_t show_parts_thread;
255 Error *local_error = NULL;
257 sioc = qio_channel_socket_new();
258 if (qio_channel_socket_connect_sync(sioc,
261 error_report_err(local_error);
265 ret = nbd_receive_negotiate(QIO_CHANNEL(sioc), NULL, &nbdflags,
267 &size, &local_error);
270 error_report_err(local_error);
275 fd = open(device, O_RDWR);
277 /* Linux-only, we can use %m in printf. */
278 error_report("Failed to open %s: %m", device);
282 ret = nbd_init(fd, sioc, nbdflags, size);
287 /* update partition table */
288 pthread_create(&show_parts_thread, NULL, show_parts, device);
291 fprintf(stderr, "NBD device %s is now connected to %s\n",
294 /* Close stderr so that the qemu-nbd process exits. */
295 dup2(STDOUT_FILENO, STDERR_FILENO);
298 ret = nbd_client(fd);
303 object_unref(OBJECT(sioc));
304 kill(getpid(), SIGTERM);
305 return (void *) EXIT_SUCCESS;
310 object_unref(OBJECT(sioc));
312 kill(getpid(), SIGTERM);
313 return (void *) EXIT_FAILURE;
316 static int nbd_can_accept(void)
318 return nb_fds < shared;
321 static void nbd_export_closed(NBDExport *exp)
323 assert(state == TERMINATING);
327 static void nbd_update_server_watch(void);
329 static void nbd_client_closed(NBDClient *client)
332 if (nb_fds == 0 && !persistent && state == RUNNING) {
335 nbd_update_server_watch();
336 nbd_client_put(client);
339 static gboolean nbd_accept(QIOChannel *ioc, GIOCondition cond, gpointer opaque)
341 QIOChannelSocket *cioc;
343 cioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(ioc),
349 if (state >= TERMINATE) {
350 object_unref(OBJECT(cioc));
355 nbd_update_server_watch();
356 nbd_client_new(newproto ? NULL : exp, cioc,
357 tlscreds, NULL, nbd_client_closed);
358 object_unref(OBJECT(cioc));
363 static void nbd_update_server_watch(void)
365 if (nbd_can_accept()) {
366 if (server_watch == -1) {
367 server_watch = qio_channel_add_watch(QIO_CHANNEL(server_ioc),
373 if (server_watch != -1) {
374 g_source_remove(server_watch);
381 static SocketAddress *nbd_build_socket_address(const char *sockpath,
385 SocketAddress *saddr;
387 saddr = g_new0(SocketAddress, 1);
389 saddr->type = SOCKET_ADDRESS_KIND_UNIX;
390 saddr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
391 saddr->u.q_unix.data->path = g_strdup(sockpath);
393 InetSocketAddress *inet;
394 saddr->type = SOCKET_ADDRESS_KIND_INET;
395 inet = saddr->u.inet.data = g_new0(InetSocketAddress, 1);
396 inet->host = g_strdup(bindto);
398 inet->port = g_strdup(port);
400 inet->port = g_strdup_printf("%d", NBD_DEFAULT_PORT);
408 static QemuOptsList file_opts = {
410 .implied_opt_name = "file",
411 .head = QTAILQ_HEAD_INITIALIZER(file_opts.head),
413 /* no elements => accept any params */
414 { /* end of list */ }
418 static QemuOptsList qemu_object_opts = {
420 .implied_opt_name = "qom-type",
421 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
429 static QCryptoTLSCreds *nbd_get_tls_creds(const char *id, Error **errp)
432 QCryptoTLSCreds *creds;
434 obj = object_resolve_path_component(
435 object_get_objects_root(), id);
437 error_setg(errp, "No TLS credentials with id '%s'",
441 creds = (QCryptoTLSCreds *)
442 object_dynamic_cast(obj, TYPE_QCRYPTO_TLS_CREDS);
444 error_setg(errp, "Object with id '%s' is not TLS credentials",
449 if (creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
451 "Expecting TLS credentials with a server endpoint");
459 int main(int argc, char **argv)
462 BlockDriverState *bs;
463 off_t dev_offset = 0;
464 uint32_t nbdflags = 0;
465 bool disconnect = false;
466 const char *bindto = "0.0.0.0";
467 const char *port = NULL;
468 char *sockpath = NULL;
471 QemuOpts *sn_opts = NULL;
472 const char *sn_id_or_name = NULL;
473 const char *sopt = "hVb:o:p:rsnP:c:dvk:e:f:tl:x:";
474 struct option lopt[] = {
475 { "help", no_argument, NULL, 'h' },
476 { "version", no_argument, NULL, 'V' },
477 { "bind", required_argument, NULL, 'b' },
478 { "port", required_argument, NULL, 'p' },
479 { "socket", required_argument, NULL, 'k' },
480 { "offset", required_argument, NULL, 'o' },
481 { "read-only", no_argument, NULL, 'r' },
482 { "partition", required_argument, NULL, 'P' },
483 { "connect", required_argument, NULL, 'c' },
484 { "disconnect", no_argument, NULL, 'd' },
485 { "snapshot", no_argument, NULL, 's' },
486 { "load-snapshot", required_argument, NULL, 'l' },
487 { "nocache", no_argument, NULL, 'n' },
488 { "cache", required_argument, NULL, QEMU_NBD_OPT_CACHE },
489 { "aio", required_argument, NULL, QEMU_NBD_OPT_AIO },
490 { "discard", required_argument, NULL, QEMU_NBD_OPT_DISCARD },
491 { "detect-zeroes", required_argument, NULL,
492 QEMU_NBD_OPT_DETECT_ZEROES },
493 { "shared", required_argument, NULL, 'e' },
494 { "format", required_argument, NULL, 'f' },
495 { "persistent", no_argument, NULL, 't' },
496 { "verbose", no_argument, NULL, 'v' },
497 { "object", required_argument, NULL, QEMU_NBD_OPT_OBJECT },
498 { "export-name", required_argument, NULL, 'x' },
499 { "tls-creds", required_argument, NULL, QEMU_NBD_OPT_TLSCREDS },
500 { "image-opts", no_argument, NULL, QEMU_NBD_OPT_IMAGE_OPTS },
506 int flags = BDRV_O_RDWR;
509 bool seen_cache = false;
510 bool seen_discard = false;
511 bool seen_aio = false;
512 pthread_t client_thread;
513 const char *fmt = NULL;
514 Error *local_err = NULL;
515 BlockdevDetectZeroesOptions detect_zeroes = BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
516 QDict *options = NULL;
517 const char *export_name = NULL;
518 const char *tlscredsid = NULL;
519 bool imageOpts = false;
520 bool writethrough = true;
522 /* The client thread uses SIGTERM to interrupt the server. A signal
523 * handler ensures that "qemu-nbd -v -c" exits with a nice status code.
525 struct sigaction sa_sigterm;
526 memset(&sa_sigterm, 0, sizeof(sa_sigterm));
527 sa_sigterm.sa_handler = termsig_handler;
528 sigaction(SIGTERM, &sa_sigterm, NULL);
530 if (qcrypto_init(&local_err) < 0) {
531 error_reportf_err(local_err, "cannot initialize crypto: ");
535 module_call_init(MODULE_INIT_QOM);
536 qemu_add_opts(&qemu_object_opts);
537 qemu_init_exec_dir(argv[0]);
539 while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
542 flags |= BDRV_O_SNAPSHOT;
545 optarg = (char *) "none";
547 case QEMU_NBD_OPT_CACHE:
549 error_report("-n and --cache can only be specified once");
553 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) == -1) {
554 error_report("Invalid cache mode `%s'", optarg);
558 case QEMU_NBD_OPT_AIO:
560 error_report("--aio can only be specified once");
564 if (!strcmp(optarg, "native")) {
565 flags |= BDRV_O_NATIVE_AIO;
566 } else if (!strcmp(optarg, "threads")) {
567 /* this is the default */
569 error_report("invalid aio mode `%s'", optarg);
573 case QEMU_NBD_OPT_DISCARD:
575 error_report("--discard can only be specified once");
579 if (bdrv_parse_discard_flags(optarg, &flags) == -1) {
580 error_report("Invalid discard mode `%s'", optarg);
584 case QEMU_NBD_OPT_DETECT_ZEROES:
586 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
588 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
589 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
592 error_reportf_err(local_err,
593 "Failed to parse detect_zeroes mode: ");
596 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
597 !(flags & BDRV_O_UNMAP)) {
598 error_report("setting detect-zeroes to unmap is not allowed "
599 "without setting discard operation to unmap");
610 dev_offset = strtoll (optarg, &end, 0);
612 error_report("Invalid offset `%s'", optarg);
615 if (dev_offset < 0) {
616 error_report("Offset must be positive `%s'", optarg);
621 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
622 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
625 error_report("Failed in parsing snapshot param `%s'",
630 sn_id_or_name = optarg;
634 nbdflags |= NBD_FLAG_READ_ONLY;
635 flags &= ~BDRV_O_RDWR;
638 partition = strtol(optarg, &end, 0);
640 error_report("Invalid partition `%s'", optarg);
643 if (partition < 1 || partition > 8) {
644 error_report("Invalid partition %d", partition);
650 if (sockpath[0] != '/') {
651 error_report("socket path must be absolute");
662 shared = strtol(optarg, &end, 0);
664 error_report("Invalid shared device number '%s'", optarg);
668 error_report("Shared device number must be greater than 0");
679 export_name = optarg;
693 error_report("Try `%s --help' for more information.", argv[0]);
695 case QEMU_NBD_OPT_OBJECT: {
697 opts = qemu_opts_parse_noisily(&qemu_object_opts,
703 case QEMU_NBD_OPT_TLSCREDS:
706 case QEMU_NBD_OPT_IMAGE_OPTS:
712 if ((argc - optind) != 1) {
713 error_report("Invalid number of arguments");
714 error_printf("Try `%s --help' for more information.\n", argv[0]);
718 if (qemu_opts_foreach(&qemu_object_opts,
719 user_creatable_add_opts_foreach,
726 error_report("TLS is only supported with IPv4/IPv6");
730 error_report("TLS is not supported with a host device");
734 /* Set the default NBD protocol export name, since
735 * we *must* use new style protocol for TLS */
738 tlscreds = nbd_get_tls_creds(tlscredsid, &local_err);
740 error_report("Failed to get TLS creds %s",
741 error_get_pretty(local_err));
747 int nbdfd = open(argv[optind], O_RDWR);
749 error_report("Cannot open %s: %s", argv[optind],
753 nbd_disconnect(nbdfd);
757 printf("%s disconnected\n", argv[optind]);
762 if (device && !verbose) {
767 if (qemu_pipe(stderr_fd) < 0) {
768 error_report("Error setting up communication pipe: %s",
773 /* Now daemonize, but keep a communication channel open to
774 * print errors and exit with the proper status code.
778 error_report("Failed to fork: %s", strerror(errno));
780 } else if (pid == 0) {
782 ret = qemu_daemon(1, 0);
784 /* Temporarily redirect stderr to the parent's pipe... */
785 dup2(stderr_fd[1], STDERR_FILENO);
787 error_report("Failed to daemonize: %s", strerror(errno));
791 /* ... close the descriptor we inherited and go on. */
797 /* In the parent. Print error messages from the child until
798 * it closes the pipe.
801 buf = g_malloc(1024);
802 while ((ret = read(stderr_fd[0], buf, 1024)) > 0) {
804 ret = qemu_write_full(STDERR_FILENO, buf, ret);
810 error_report("Cannot read from daemon: %s",
815 /* Usually the daemon should not print any message.
816 * Exit with zero status in that case.
822 if (device != NULL && sockpath == NULL) {
823 sockpath = g_malloc(128);
824 snprintf(sockpath, 128, SOCKET_PATH, basename(device));
827 saddr = nbd_build_socket_address(sockpath, bindto, port);
829 if (qemu_init_main_loop(&local_err)) {
830 error_report_err(local_err);
834 atexit(bdrv_close_all);
836 srcpath = argv[optind];
840 error_report("--image-opts and -f are mutually exclusive");
843 opts = qemu_opts_parse_noisily(&file_opts, srcpath, true);
845 qemu_opts_reset(&file_opts);
848 options = qemu_opts_to_qdict(opts, NULL);
849 qemu_opts_reset(&file_opts);
850 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
853 options = qdict_new();
854 qdict_put(options, "driver", qstring_from_str(fmt));
856 blk = blk_new_open(srcpath, NULL, options, flags, &local_err);
860 error_reportf_err(local_err, "Failed to blk_new_open '%s': ",
866 blk_set_enable_write_cache(blk, !writethrough);
869 ret = bdrv_snapshot_load_tmp(bs,
870 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
871 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
873 } else if (sn_id_or_name) {
874 ret = bdrv_snapshot_load_tmp_by_id_or_name(bs, sn_id_or_name,
878 error_reportf_err(local_err, "Failed to load snapshot: ");
882 bs->detect_zeroes = detect_zeroes;
883 fd_size = blk_getlength(blk);
885 error_report("Failed to determine the image length: %s",
890 if (partition != -1) {
891 ret = find_partition(blk, partition, &dev_offset, &fd_size);
893 error_report("Could not find partition %d: %s", partition,
899 exp = nbd_export_new(blk, dev_offset, fd_size, nbdflags, nbd_export_closed,
902 error_report_err(local_err);
906 nbd_export_set_name(exp, export_name);
910 server_ioc = qio_channel_socket_new();
911 if (qio_channel_socket_listen_sync(server_ioc, saddr, &local_err) < 0) {
912 object_unref(OBJECT(server_ioc));
913 error_report_err(local_err);
920 ret = pthread_create(&client_thread, NULL, nbd_client_thread, device);
922 error_report("Failed to create client thread: %s", strerror(ret));
926 /* Shut up GCC warnings. */
927 memset(&client_thread, 0, sizeof(client_thread));
930 nbd_update_server_watch();
932 /* now when the initialization is (almost) complete, chdir("/")
933 * to free any busy filesystems */
934 if (chdir("/") < 0) {
935 error_report("Could not chdir to root directory: %s",
942 main_loop_wait(false);
943 if (state == TERMINATE) {
945 nbd_export_close(exp);
949 } while (state != TERMINATED);
956 qemu_opts_del(sn_opts);
960 pthread_join(client_thread, &ret);