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"
31 #include "block/snapshot.h"
32 #include "qapi/util.h"
33 #include "qapi/qmp/qstring.h"
34 #include "qom/object_interfaces.h"
35 #include "io/channel-socket.h"
36 #include "crypto/init.h"
37 #include "trace/control.h"
43 #define SOCKET_PATH "/var/lock/qemu-nbd-%s"
44 #define QEMU_NBD_OPT_CACHE 256
45 #define QEMU_NBD_OPT_AIO 257
46 #define QEMU_NBD_OPT_DISCARD 258
47 #define QEMU_NBD_OPT_DETECT_ZEROES 259
48 #define QEMU_NBD_OPT_OBJECT 260
49 #define QEMU_NBD_OPT_TLSCREDS 261
50 #define QEMU_NBD_OPT_IMAGE_OPTS 262
51 #define QEMU_NBD_OPT_FORK 263
55 static NBDExport *exp;
59 static SocketAddress *saddr;
60 static int persistent = 0;
61 static enum { RUNNING, TERMINATE, TERMINATING, TERMINATED } state;
62 static int shared = 1;
64 static QIOChannelSocket *server_ioc;
65 static int server_watch = -1;
66 static QCryptoTLSCreds *tlscreds;
68 static void usage(const char *name)
71 "Usage: %s [OPTIONS] FILE\n"
72 "QEMU Disk Network Block Device Server\n"
74 " -h, --help display this help and exit\n"
75 " -V, --version output version information and exit\n"
77 "Connection properties:\n"
78 " -p, --port=PORT port to listen on (default `%d')\n"
79 " -b, --bind=IFACE interface to bind to (default `0.0.0.0')\n"
80 " -k, --socket=PATH path to the unix socket\n"
81 " (default '"SOCKET_PATH"')\n"
82 " -e, --shared=NUM device can be shared by NUM clients (default '1')\n"
83 " -t, --persistent don't exit on the last connection\n"
84 " -v, --verbose display extra debugging information\n"
85 " -x, --export-name=NAME expose export by name\n"
86 " -D, --description=TEXT with -x, also export a human-readable description\n"
88 "Exposing part of the image:\n"
89 " -o, --offset=OFFSET offset into the image\n"
90 " -P, --partition=NUM only expose partition NUM\n"
92 "General purpose options:\n"
93 " --object type,id=ID,... define an object such as 'secret' for providing\n"
94 " passwords and/or encryption keys\n"
95 " -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
96 " specify tracing options\n"
97 " --fork fork off the server process and exit the parent\n"
98 " once the server is running\n"
100 "Kernel NBD client support:\n"
101 " -c, --connect=DEV connect FILE to the local NBD device DEV\n"
102 " -d, --disconnect disconnect the specified device\n"
106 "Block device options:\n"
107 " -f, --format=FORMAT set image format (raw, qcow2, ...)\n"
108 " -r, --read-only export read-only\n"
109 " -s, --snapshot use FILE as an external snapshot, create a temporary\n"
110 " file with backing_file=FILE, redirect the write to\n"
111 " the temporary one\n"
112 " -l, --load-snapshot=SNAPSHOT_PARAM\n"
113 " load an internal snapshot inside FILE and export it\n"
114 " as an read-only device, SNAPSHOT_PARAM format is\n"
115 " 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
117 " -n, --nocache disable host cache\n"
118 " --cache=MODE set cache mode (none, writeback, ...)\n"
119 " --aio=MODE set AIO mode (native or threads)\n"
120 " --discard=MODE set discard mode (ignore, unmap)\n"
121 " --detect-zeroes=MODE set detect-zeroes mode (off, on, unmap)\n"
122 " --image-opts treat FILE as a full set of image options\n"
125 , name, NBD_DEFAULT_PORT, "DEVICE");
128 static void version(const char *name)
132 "Written by Anthony Liguori.\n"
135 "This is free software; see the source for copying conditions. There is NO\n"
136 "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
140 struct partition_record
144 uint32_t start_cylinder;
145 uint8_t start_sector;
148 uint8_t end_cylinder;
150 uint32_t start_sector_abs;
151 uint32_t nb_sectors_abs;
154 static void read_partition(uint8_t *p, struct partition_record *r)
157 r->start_head = p[1];
158 r->start_cylinder = p[3] | ((p[2] << 2) & 0x0300);
159 r->start_sector = p[2] & 0x3f;
162 r->end_cylinder = p[7] | ((p[6] << 2) & 0x300);
163 r->end_sector = p[6] & 0x3f;
165 r->start_sector_abs = ldl_le_p(p + 8);
166 r->nb_sectors_abs = ldl_le_p(p + 12);
169 static int find_partition(BlockBackend *blk, int partition,
170 off_t *offset, off_t *size)
172 struct partition_record mbr[4];
173 uint8_t data[MBR_SIZE];
178 ret = blk_pread(blk, 0, data, sizeof(data));
180 error_report("error while reading: %s", strerror(-ret));
184 if (data[510] != 0x55 || data[511] != 0xaa) {
188 for (i = 0; i < 4; i++) {
189 read_partition(&data[446 + 16 * i], &mbr[i]);
191 if (!mbr[i].system || !mbr[i].nb_sectors_abs) {
195 if (mbr[i].system == 0xF || mbr[i].system == 0x5) {
196 struct partition_record ext[4];
197 uint8_t data1[MBR_SIZE];
200 ret = blk_pread(blk, mbr[i].start_sector_abs * MBR_SIZE,
201 data1, sizeof(data1));
203 error_report("error while reading: %s", strerror(-ret));
207 for (j = 0; j < 4; j++) {
208 read_partition(&data1[446 + 16 * j], &ext[j]);
209 if (!ext[j].system || !ext[j].nb_sectors_abs) {
213 if ((ext_partnum + j + 1) == partition) {
214 *offset = (uint64_t)ext[j].start_sector_abs << 9;
215 *size = (uint64_t)ext[j].nb_sectors_abs << 9;
220 } else if ((i + 1) == partition) {
221 *offset = (uint64_t)mbr[i].start_sector_abs << 9;
222 *size = (uint64_t)mbr[i].nb_sectors_abs << 9;
230 static void termsig_handler(int signum)
232 atomic_cmpxchg(&state, RUNNING, TERMINATE);
237 static void *show_parts(void *arg)
242 /* linux just needs an open() to trigger
243 * the partition table update
244 * but remember to load the module with max_part != 0 :
245 * modprobe nbd max_part=63
247 nbd = open(device, O_RDWR);
254 static void *nbd_client_thread(void *arg)
259 QIOChannelSocket *sioc;
262 pthread_t show_parts_thread;
263 Error *local_error = NULL;
265 sioc = qio_channel_socket_new();
266 if (qio_channel_socket_connect_sync(sioc,
269 error_report_err(local_error);
273 ret = nbd_receive_negotiate(QIO_CHANNEL(sioc), NULL, &nbdflags,
275 &size, &local_error);
278 error_report_err(local_error);
283 fd = open(device, O_RDWR);
285 /* Linux-only, we can use %m in printf. */
286 error_report("Failed to open %s: %m", device);
290 ret = nbd_init(fd, sioc, nbdflags, size);
295 /* update partition table */
296 pthread_create(&show_parts_thread, NULL, show_parts, device);
299 fprintf(stderr, "NBD device %s is now connected to %s\n",
302 /* Close stderr so that the qemu-nbd process exits. */
303 dup2(STDOUT_FILENO, STDERR_FILENO);
306 ret = nbd_client(fd);
311 object_unref(OBJECT(sioc));
312 kill(getpid(), SIGTERM);
313 return (void *) EXIT_SUCCESS;
318 object_unref(OBJECT(sioc));
320 kill(getpid(), SIGTERM);
321 return (void *) EXIT_FAILURE;
324 static int nbd_can_accept(void)
326 return nb_fds < shared;
329 static void nbd_export_closed(NBDExport *exp)
331 assert(state == TERMINATING);
335 static void nbd_update_server_watch(void);
337 static void nbd_client_closed(NBDClient *client)
340 if (nb_fds == 0 && !persistent && state == RUNNING) {
343 nbd_update_server_watch();
344 nbd_client_put(client);
347 static gboolean nbd_accept(QIOChannel *ioc, GIOCondition cond, gpointer opaque)
349 QIOChannelSocket *cioc;
351 cioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(ioc),
357 if (state >= TERMINATE) {
358 object_unref(OBJECT(cioc));
363 nbd_update_server_watch();
364 nbd_client_new(newproto ? NULL : exp, cioc,
365 tlscreds, NULL, nbd_client_closed);
366 object_unref(OBJECT(cioc));
371 static void nbd_update_server_watch(void)
373 if (nbd_can_accept()) {
374 if (server_watch == -1) {
375 server_watch = qio_channel_add_watch(QIO_CHANNEL(server_ioc),
381 if (server_watch != -1) {
382 g_source_remove(server_watch);
389 static SocketAddress *nbd_build_socket_address(const char *sockpath,
393 SocketAddress *saddr;
395 saddr = g_new0(SocketAddress, 1);
397 saddr->type = SOCKET_ADDRESS_KIND_UNIX;
398 saddr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
399 saddr->u.q_unix.data->path = g_strdup(sockpath);
401 InetSocketAddress *inet;
402 saddr->type = SOCKET_ADDRESS_KIND_INET;
403 inet = saddr->u.inet.data = g_new0(InetSocketAddress, 1);
404 inet->host = g_strdup(bindto);
406 inet->port = g_strdup(port);
408 inet->port = g_strdup_printf("%d", NBD_DEFAULT_PORT);
416 static QemuOptsList file_opts = {
418 .implied_opt_name = "file",
419 .head = QTAILQ_HEAD_INITIALIZER(file_opts.head),
421 /* no elements => accept any params */
422 { /* end of list */ }
426 static QemuOptsList qemu_object_opts = {
428 .implied_opt_name = "qom-type",
429 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
437 static QCryptoTLSCreds *nbd_get_tls_creds(const char *id, Error **errp)
440 QCryptoTLSCreds *creds;
442 obj = object_resolve_path_component(
443 object_get_objects_root(), id);
445 error_setg(errp, "No TLS credentials with id '%s'",
449 creds = (QCryptoTLSCreds *)
450 object_dynamic_cast(obj, TYPE_QCRYPTO_TLS_CREDS);
452 error_setg(errp, "Object with id '%s' is not TLS credentials",
457 if (creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
459 "Expecting TLS credentials with a server endpoint");
467 int main(int argc, char **argv)
470 BlockDriverState *bs;
471 off_t dev_offset = 0;
472 uint16_t nbdflags = 0;
473 bool disconnect = false;
474 const char *bindto = "0.0.0.0";
475 const char *port = NULL;
476 char *sockpath = NULL;
479 QemuOpts *sn_opts = NULL;
480 const char *sn_id_or_name = NULL;
481 const char *sopt = "hVb:o:p:rsnP:c:dvk:e:f:tl:x:T:D:";
482 struct option lopt[] = {
483 { "help", no_argument, NULL, 'h' },
484 { "version", no_argument, NULL, 'V' },
485 { "bind", required_argument, NULL, 'b' },
486 { "port", required_argument, NULL, 'p' },
487 { "socket", required_argument, NULL, 'k' },
488 { "offset", required_argument, NULL, 'o' },
489 { "read-only", no_argument, NULL, 'r' },
490 { "partition", required_argument, NULL, 'P' },
491 { "connect", required_argument, NULL, 'c' },
492 { "disconnect", no_argument, NULL, 'd' },
493 { "snapshot", no_argument, NULL, 's' },
494 { "load-snapshot", required_argument, NULL, 'l' },
495 { "nocache", no_argument, NULL, 'n' },
496 { "cache", required_argument, NULL, QEMU_NBD_OPT_CACHE },
497 { "aio", required_argument, NULL, QEMU_NBD_OPT_AIO },
498 { "discard", required_argument, NULL, QEMU_NBD_OPT_DISCARD },
499 { "detect-zeroes", required_argument, NULL,
500 QEMU_NBD_OPT_DETECT_ZEROES },
501 { "shared", required_argument, NULL, 'e' },
502 { "format", required_argument, NULL, 'f' },
503 { "persistent", no_argument, NULL, 't' },
504 { "verbose", no_argument, NULL, 'v' },
505 { "object", required_argument, NULL, QEMU_NBD_OPT_OBJECT },
506 { "export-name", required_argument, NULL, 'x' },
507 { "description", required_argument, NULL, 'D' },
508 { "tls-creds", required_argument, NULL, QEMU_NBD_OPT_TLSCREDS },
509 { "image-opts", no_argument, NULL, QEMU_NBD_OPT_IMAGE_OPTS },
510 { "trace", required_argument, NULL, 'T' },
511 { "fork", no_argument, NULL, QEMU_NBD_OPT_FORK },
517 int flags = BDRV_O_RDWR;
520 bool seen_cache = false;
521 bool seen_discard = false;
522 bool seen_aio = false;
523 pthread_t client_thread;
524 const char *fmt = NULL;
525 Error *local_err = NULL;
526 BlockdevDetectZeroesOptions detect_zeroes = BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
527 QDict *options = NULL;
528 const char *export_name = NULL;
529 const char *export_description = NULL;
530 const char *tlscredsid = NULL;
531 bool imageOpts = false;
532 bool writethrough = true;
533 char *trace_file = NULL;
534 bool fork_process = false;
537 /* The client thread uses SIGTERM to interrupt the server. A signal
538 * handler ensures that "qemu-nbd -v -c" exits with a nice status code.
540 struct sigaction sa_sigterm;
541 memset(&sa_sigterm, 0, sizeof(sa_sigterm));
542 sa_sigterm.sa_handler = termsig_handler;
543 sigaction(SIGTERM, &sa_sigterm, NULL);
545 module_call_init(MODULE_INIT_TRACE);
546 qcrypto_init(&error_fatal);
548 module_call_init(MODULE_INIT_QOM);
549 qemu_add_opts(&qemu_object_opts);
550 qemu_add_opts(&qemu_trace_opts);
551 qemu_init_exec_dir(argv[0]);
553 while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
556 flags |= BDRV_O_SNAPSHOT;
559 optarg = (char *) "none";
561 case QEMU_NBD_OPT_CACHE:
563 error_report("-n and --cache can only be specified once");
567 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) == -1) {
568 error_report("Invalid cache mode `%s'", optarg);
572 case QEMU_NBD_OPT_AIO:
574 error_report("--aio can only be specified once");
578 if (!strcmp(optarg, "native")) {
579 flags |= BDRV_O_NATIVE_AIO;
580 } else if (!strcmp(optarg, "threads")) {
581 /* this is the default */
583 error_report("invalid aio mode `%s'", optarg);
587 case QEMU_NBD_OPT_DISCARD:
589 error_report("--discard can only be specified once");
593 if (bdrv_parse_discard_flags(optarg, &flags) == -1) {
594 error_report("Invalid discard mode `%s'", optarg);
598 case QEMU_NBD_OPT_DETECT_ZEROES:
600 qapi_enum_parse(BlockdevDetectZeroesOptions_lookup,
602 BLOCKDEV_DETECT_ZEROES_OPTIONS__MAX,
603 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
606 error_reportf_err(local_err,
607 "Failed to parse detect_zeroes mode: ");
610 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
611 !(flags & BDRV_O_UNMAP)) {
612 error_report("setting detect-zeroes to unmap is not allowed "
613 "without setting discard operation to unmap");
624 dev_offset = strtoll (optarg, &end, 0);
626 error_report("Invalid offset `%s'", optarg);
629 if (dev_offset < 0) {
630 error_report("Offset must be positive `%s'", optarg);
635 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
636 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
639 error_report("Failed in parsing snapshot param `%s'",
644 sn_id_or_name = optarg;
648 nbdflags |= NBD_FLAG_READ_ONLY;
649 flags &= ~BDRV_O_RDWR;
652 partition = strtol(optarg, &end, 0);
654 error_report("Invalid partition `%s'", optarg);
657 if (partition < 1 || partition > 8) {
658 error_report("Invalid partition %d", partition);
664 if (sockpath[0] != '/') {
665 error_report("socket path must be absolute");
676 shared = strtol(optarg, &end, 0);
678 error_report("Invalid shared device number '%s'", optarg);
682 error_report("Shared device number must be greater than 0");
693 export_name = optarg;
696 export_description = optarg;
710 error_report("Try `%s --help' for more information.", argv[0]);
712 case QEMU_NBD_OPT_OBJECT: {
714 opts = qemu_opts_parse_noisily(&qemu_object_opts,
720 case QEMU_NBD_OPT_TLSCREDS:
723 case QEMU_NBD_OPT_IMAGE_OPTS:
728 trace_file = trace_opt_parse(optarg);
730 case QEMU_NBD_OPT_FORK:
736 if ((argc - optind) != 1) {
737 error_report("Invalid number of arguments");
738 error_printf("Try `%s --help' for more information.\n", argv[0]);
742 if (qemu_opts_foreach(&qemu_object_opts,
743 user_creatable_add_opts_foreach,
748 if (!trace_init_backends()) {
751 trace_init_file(trace_file);
752 qemu_set_log(LOG_TRACE);
756 error_report("TLS is only supported with IPv4/IPv6");
760 error_report("TLS is not supported with a host device");
764 /* Set the default NBD protocol export name, since
765 * we *must* use new style protocol for TLS */
768 tlscreds = nbd_get_tls_creds(tlscredsid, &local_err);
770 error_report("Failed to get TLS creds %s",
771 error_get_pretty(local_err));
777 int nbdfd = open(argv[optind], O_RDWR);
779 error_report("Cannot open %s: %s", argv[optind],
783 nbd_disconnect(nbdfd);
787 printf("%s disconnected\n", argv[optind]);
792 if ((device && !verbose) || fork_process) {
797 if (qemu_pipe(stderr_fd) < 0) {
798 error_report("Error setting up communication pipe: %s",
803 /* Now daemonize, but keep a communication channel open to
804 * print errors and exit with the proper status code.
808 error_report("Failed to fork: %s", strerror(errno));
810 } else if (pid == 0) {
812 ret = qemu_daemon(1, 0);
814 /* Temporarily redirect stderr to the parent's pipe... */
815 old_stderr = dup(STDERR_FILENO);
816 dup2(stderr_fd[1], STDERR_FILENO);
818 error_report("Failed to daemonize: %s", strerror(errno));
822 /* ... close the descriptor we inherited and go on. */
828 /* In the parent. Print error messages from the child until
829 * it closes the pipe.
832 buf = g_malloc(1024);
833 while ((ret = read(stderr_fd[0], buf, 1024)) > 0) {
835 ret = qemu_write_full(STDERR_FILENO, buf, ret);
841 error_report("Cannot read from daemon: %s",
846 /* Usually the daemon should not print any message.
847 * Exit with zero status in that case.
853 if (device != NULL && sockpath == NULL) {
854 sockpath = g_malloc(128);
855 snprintf(sockpath, 128, SOCKET_PATH, basename(device));
858 saddr = nbd_build_socket_address(sockpath, bindto, port);
860 if (qemu_init_main_loop(&local_err)) {
861 error_report_err(local_err);
865 atexit(bdrv_close_all);
867 srcpath = argv[optind];
871 error_report("--image-opts and -f are mutually exclusive");
874 opts = qemu_opts_parse_noisily(&file_opts, srcpath, true);
876 qemu_opts_reset(&file_opts);
879 options = qemu_opts_to_qdict(opts, NULL);
880 qemu_opts_reset(&file_opts);
881 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
884 options = qdict_new();
885 qdict_put(options, "driver", qstring_from_str(fmt));
887 blk = blk_new_open(srcpath, NULL, options, flags, &local_err);
891 error_reportf_err(local_err, "Failed to blk_new_open '%s': ",
897 blk_set_enable_write_cache(blk, !writethrough);
900 ret = bdrv_snapshot_load_tmp(bs,
901 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
902 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
904 } else if (sn_id_or_name) {
905 ret = bdrv_snapshot_load_tmp_by_id_or_name(bs, sn_id_or_name,
909 error_reportf_err(local_err, "Failed to load snapshot: ");
913 bs->detect_zeroes = detect_zeroes;
914 fd_size = blk_getlength(blk);
916 error_report("Failed to determine the image length: %s",
921 if (dev_offset >= fd_size) {
922 error_report("Offset (%lld) has to be smaller than the image size "
924 (long long int)dev_offset, (long long int)fd_size);
927 fd_size -= dev_offset;
929 if (partition != -1) {
930 ret = find_partition(blk, partition, &dev_offset, &fd_size);
932 error_report("Could not find partition %d: %s", partition,
938 exp = nbd_export_new(bs, dev_offset, fd_size, nbdflags, nbd_export_closed,
939 writethrough, NULL, &local_err);
941 error_report_err(local_err);
945 nbd_export_set_name(exp, export_name);
946 nbd_export_set_description(exp, export_description);
948 } else if (export_description) {
949 error_report("Export description requires an export name");
953 server_ioc = qio_channel_socket_new();
954 if (qio_channel_socket_listen_sync(server_ioc, saddr, &local_err) < 0) {
955 object_unref(OBJECT(server_ioc));
956 error_report_err(local_err);
963 ret = pthread_create(&client_thread, NULL, nbd_client_thread, device);
965 error_report("Failed to create client thread: %s", strerror(ret));
969 /* Shut up GCC warnings. */
970 memset(&client_thread, 0, sizeof(client_thread));
973 nbd_update_server_watch();
975 /* now when the initialization is (almost) complete, chdir("/")
976 * to free any busy filesystems */
977 if (chdir("/") < 0) {
978 error_report("Could not chdir to root directory: %s",
984 dup2(old_stderr, STDERR_FILENO);
990 main_loop_wait(false);
991 if (state == TERMINATE) {
993 nbd_export_close(exp);
997 } while (state != TERMINATED);
1004 qemu_opts_del(sn_opts);
1008 pthread_join(client_thread, &ret);