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"
24 #include "qemu-common.h"
25 #include "qapi/error.h"
26 #include "qemu/cutils.h"
27 #include "sysemu/block-backend.h"
28 #include "block/block_int.h"
29 #include "block/nbd.h"
30 #include "qemu/main-loop.h"
31 #include "qemu/module.h"
32 #include "qemu/option.h"
33 #include "qemu/error-report.h"
34 #include "qemu/config-file.h"
35 #include "qemu/bswap.h"
37 #include "qemu/systemd.h"
38 #include "block/snapshot.h"
39 #include "qapi/qmp/qdict.h"
40 #include "qapi/qmp/qstring.h"
41 #include "qom/object_interfaces.h"
42 #include "io/channel-socket.h"
43 #include "io/net-listener.h"
44 #include "crypto/init.h"
45 #include "trace/control.h"
46 #include "qemu-version.h"
49 #define HAVE_NBD_DEVICE 1
51 #define HAVE_NBD_DEVICE 0
54 #define SOCKET_PATH "/var/lock/qemu-nbd-%s"
55 #define QEMU_NBD_OPT_CACHE 256
56 #define QEMU_NBD_OPT_AIO 257
57 #define QEMU_NBD_OPT_DISCARD 258
58 #define QEMU_NBD_OPT_DETECT_ZEROES 259
59 #define QEMU_NBD_OPT_OBJECT 260
60 #define QEMU_NBD_OPT_TLSCREDS 261
61 #define QEMU_NBD_OPT_IMAGE_OPTS 262
62 #define QEMU_NBD_OPT_FORK 263
63 #define QEMU_NBD_OPT_TLSAUTHZ 264
64 #define QEMU_NBD_OPT_PID_FILE 265
68 static NBDExport
*export
;
71 static SocketAddress
*saddr
;
72 static int persistent
= 0;
73 static enum { RUNNING
, TERMINATE
, TERMINATING
, TERMINATED
} state
;
74 static int shared
= 1;
76 static QIONetListener
*server
;
77 static QCryptoTLSCreds
*tlscreds
;
78 static const char *tlsauthz
;
80 static void usage(const char *name
)
83 "Usage: %s [OPTIONS] FILE\n"
84 " or: %s -L [OPTIONS]\n"
85 "QEMU Disk Network Block Device Utility\n"
87 " -h, --help display this help and exit\n"
88 " -V, --version output version information and exit\n"
90 "Connection properties:\n"
91 " -p, --port=PORT port to listen on (default `%d')\n"
92 " -b, --bind=IFACE interface to bind to (default `0.0.0.0')\n"
93 " -k, --socket=PATH path to the unix socket\n"
94 " (default '"SOCKET_PATH
"')\n"
95 " -e, --shared=NUM device can be shared by NUM clients (default '1')\n"
96 " -t, --persistent don't exit on the last connection\n"
97 " -v, --verbose display extra debugging information\n"
98 " -x, --export-name=NAME expose export by name (default is empty string)\n"
99 " -D, --description=TEXT export a human-readable description\n"
101 "Exposing part of the image:\n"
102 " -o, --offset=OFFSET offset into the image\n"
103 " -P, --partition=NUM only expose partition NUM\n"
104 " -B, --bitmap=NAME expose a persistent dirty bitmap\n"
106 "General purpose options:\n"
107 " -L, --list list exports available from another NBD server\n"
108 " --object type,id=ID,... define an object such as 'secret' for providing\n"
109 " passwords and/or encryption keys\n"
110 " --tls-creds=ID use id of an earlier --object to provide TLS\n"
111 " --tls-authz=ID use id of an earlier --object to provide\n"
113 " -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
114 " specify tracing options\n"
115 " --fork fork off the server process and exit the parent\n"
116 " once the server is running\n"
117 " --pid-file=PATH store the server's process ID in the given file\n"
120 "Kernel NBD client support:\n"
121 " -c, --connect=DEV connect FILE to the local NBD device DEV\n"
122 " -d, --disconnect disconnect the specified device\n"
125 "Block device options:\n"
126 " -f, --format=FORMAT set image format (raw, qcow2, ...)\n"
127 " -r, --read-only export read-only\n"
128 " -s, --snapshot use FILE as an external snapshot, create a temporary\n"
129 " file with backing_file=FILE, redirect the write to\n"
130 " the temporary one\n"
131 " -l, --load-snapshot=SNAPSHOT_PARAM\n"
132 " load an internal snapshot inside FILE and export it\n"
133 " as an read-only device, SNAPSHOT_PARAM format is\n"
134 " 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
136 " -n, --nocache disable host cache\n"
137 " --cache=MODE set cache mode (none, writeback, ...)\n"
138 " --aio=MODE set AIO mode (native or threads)\n"
139 " --discard=MODE set discard mode (ignore, unmap)\n"
140 " --detect-zeroes=MODE set detect-zeroes mode (off, on, unmap)\n"
141 " --image-opts treat FILE as a full set of image options\n"
143 QEMU_HELP_BOTTOM
"\n"
144 , name
, name
, NBD_DEFAULT_PORT
, "DEVICE");
147 static void version(const char *name
)
150 "%s " QEMU_FULL_VERSION
"\n"
151 "Written by Anthony Liguori.\n"
154 "This is free software; see the source for copying conditions. There is NO\n"
155 "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
159 struct partition_record
163 uint32_t start_cylinder
;
164 uint8_t start_sector
;
167 uint8_t end_cylinder
;
169 uint32_t start_sector_abs
;
170 uint32_t nb_sectors_abs
;
173 static void read_partition(uint8_t *p
, struct partition_record
*r
)
176 r
->start_head
= p
[1];
177 r
->start_cylinder
= p
[3] | ((p
[2] << 2) & 0x0300);
178 r
->start_sector
= p
[2] & 0x3f;
181 r
->end_cylinder
= p
[7] | ((p
[6] << 2) & 0x300);
182 r
->end_sector
= p
[6] & 0x3f;
184 r
->start_sector_abs
= ldl_le_p(p
+ 8);
185 r
->nb_sectors_abs
= ldl_le_p(p
+ 12);
188 static int find_partition(BlockBackend
*blk
, int partition
,
189 uint64_t *offset
, uint64_t *size
)
191 struct partition_record mbr
[4];
192 uint8_t data
[MBR_SIZE
];
197 ret
= blk_pread(blk
, 0, data
, sizeof(data
));
199 error_report("error while reading: %s", strerror(-ret
));
203 if (data
[510] != 0x55 || data
[511] != 0xaa) {
207 for (i
= 0; i
< 4; i
++) {
208 read_partition(&data
[446 + 16 * i
], &mbr
[i
]);
210 if (!mbr
[i
].system
|| !mbr
[i
].nb_sectors_abs
) {
214 if (mbr
[i
].system
== 0xF || mbr
[i
].system
== 0x5) {
215 struct partition_record ext
[4];
216 uint8_t data1
[MBR_SIZE
];
219 ret
= blk_pread(blk
, mbr
[i
].start_sector_abs
* MBR_SIZE
,
220 data1
, sizeof(data1
));
222 error_report("error while reading: %s", strerror(-ret
));
226 for (j
= 0; j
< 4; j
++) {
227 read_partition(&data1
[446 + 16 * j
], &ext
[j
]);
228 if (!ext
[j
].system
|| !ext
[j
].nb_sectors_abs
) {
232 if ((ext_partnum
+ j
+ 1) == partition
) {
233 *offset
= (uint64_t)ext
[j
].start_sector_abs
<< 9;
234 *size
= (uint64_t)ext
[j
].nb_sectors_abs
<< 9;
239 } else if ((i
+ 1) == partition
) {
240 *offset
= (uint64_t)mbr
[i
].start_sector_abs
<< 9;
241 *size
= (uint64_t)mbr
[i
].nb_sectors_abs
<< 9;
249 static void termsig_handler(int signum
)
251 atomic_cmpxchg(&state
, RUNNING
, TERMINATE
);
256 static int qemu_nbd_client_list(SocketAddress
*saddr
, QCryptoTLSCreds
*tls
,
257 const char *hostname
)
259 int ret
= EXIT_FAILURE
;
262 QIOChannelSocket
*sioc
;
266 sioc
= qio_channel_socket_new();
267 if (qio_channel_socket_connect_sync(sioc
, saddr
, &err
) < 0) {
268 error_report_err(err
);
271 rc
= nbd_receive_export_list(QIO_CHANNEL(sioc
), tls
, hostname
, &list
,
275 error_report_err(err
);
279 printf("exports available: %d\n", rc
);
280 for (i
= 0; i
< rc
; i
++) {
281 printf(" export: '%s'\n", list
[i
].name
);
282 if (list
[i
].description
&& *list
[i
].description
) {
283 printf(" description: %s\n", list
[i
].description
);
285 if (list
[i
].flags
& NBD_FLAG_HAS_FLAGS
) {
286 static const char *const flag_names
[] = {
287 [NBD_FLAG_READ_ONLY_BIT
] = "readonly",
288 [NBD_FLAG_SEND_FLUSH_BIT
] = "flush",
289 [NBD_FLAG_SEND_FUA_BIT
] = "fua",
290 [NBD_FLAG_ROTATIONAL_BIT
] = "rotational",
291 [NBD_FLAG_SEND_TRIM_BIT
] = "trim",
292 [NBD_FLAG_SEND_WRITE_ZEROES_BIT
] = "zeroes",
293 [NBD_FLAG_SEND_DF_BIT
] = "df",
294 [NBD_FLAG_CAN_MULTI_CONN_BIT
] = "multi",
295 [NBD_FLAG_SEND_RESIZE_BIT
] = "resize",
296 [NBD_FLAG_SEND_CACHE_BIT
] = "cache",
299 printf(" size: %" PRIu64
"\n", list
[i
].size
);
300 printf(" flags: 0x%x (", list
[i
].flags
);
301 for (size_t bit
= 0; bit
< ARRAY_SIZE(flag_names
); bit
++) {
302 if (flag_names
[bit
] && (list
[i
].flags
& (1 << bit
))) {
303 printf(" %s", flag_names
[bit
]);
308 if (list
[i
].min_block
) {
309 printf(" min block: %u\n", list
[i
].min_block
);
310 printf(" opt block: %u\n", list
[i
].opt_block
);
311 printf(" max block: %u\n", list
[i
].max_block
);
313 if (list
[i
].n_contexts
) {
314 printf(" available meta contexts: %d\n", list
[i
].n_contexts
);
315 for (j
= 0; j
< list
[i
].n_contexts
; j
++) {
316 printf(" %s\n", list
[i
].contexts
[j
]);
320 nbd_free_export_list(list
, rc
);
324 object_unref(OBJECT(sioc
));
330 static void *show_parts(void *arg
)
335 /* linux just needs an open() to trigger
336 * the partition table update
337 * but remember to load the module with max_part != 0 :
338 * modprobe nbd max_part=63
340 nbd
= open(device
, O_RDWR
);
347 static void *nbd_client_thread(void *arg
)
350 NBDExportInfo info
= { .request_sizes
= false, .name
= g_strdup("") };
351 QIOChannelSocket
*sioc
;
354 pthread_t show_parts_thread
;
355 Error
*local_error
= NULL
;
357 sioc
= qio_channel_socket_new();
358 if (qio_channel_socket_connect_sync(sioc
,
361 error_report_err(local_error
);
365 ret
= nbd_receive_negotiate(QIO_CHANNEL(sioc
),
366 NULL
, NULL
, NULL
, &info
, &local_error
);
369 error_report_err(local_error
);
374 fd
= open(device
, O_RDWR
);
376 /* Linux-only, we can use %m in printf. */
377 error_report("Failed to open %s: %m", device
);
381 ret
= nbd_init(fd
, sioc
, &info
, &local_error
);
383 error_report_err(local_error
);
387 /* update partition table */
388 pthread_create(&show_parts_thread
, NULL
, show_parts
, device
);
391 fprintf(stderr
, "NBD device %s is now connected to %s\n",
394 /* Close stderr so that the qemu-nbd process exits. */
395 dup2(STDOUT_FILENO
, STDERR_FILENO
);
398 ret
= nbd_client(fd
);
403 object_unref(OBJECT(sioc
));
405 kill(getpid(), SIGTERM
);
406 return (void *) EXIT_SUCCESS
;
411 object_unref(OBJECT(sioc
));
414 kill(getpid(), SIGTERM
);
415 return (void *) EXIT_FAILURE
;
417 #endif /* HAVE_NBD_DEVICE */
419 static int nbd_can_accept(void)
421 return state
== RUNNING
&& nb_fds
< shared
;
424 static void nbd_export_closed(NBDExport
*export
)
426 assert(state
== TERMINATING
);
430 static void nbd_update_server_watch(void);
432 static void nbd_client_closed(NBDClient
*client
, bool negotiated
)
435 if (negotiated
&& nb_fds
== 0 && !persistent
&& state
== RUNNING
) {
438 nbd_update_server_watch();
439 nbd_client_put(client
);
442 static void nbd_accept(QIONetListener
*listener
, QIOChannelSocket
*cioc
,
445 if (state
>= TERMINATE
) {
450 nbd_update_server_watch();
451 nbd_client_new(cioc
, tlscreds
, tlsauthz
, nbd_client_closed
);
454 static void nbd_update_server_watch(void)
456 if (nbd_can_accept()) {
457 qio_net_listener_set_client_func(server
, nbd_accept
, NULL
, NULL
);
459 qio_net_listener_set_client_func(server
, NULL
, NULL
, NULL
);
464 static SocketAddress
*nbd_build_socket_address(const char *sockpath
,
468 SocketAddress
*saddr
;
470 saddr
= g_new0(SocketAddress
, 1);
472 saddr
->type
= SOCKET_ADDRESS_TYPE_UNIX
;
473 saddr
->u
.q_unix
.path
= g_strdup(sockpath
);
475 InetSocketAddress
*inet
;
476 saddr
->type
= SOCKET_ADDRESS_TYPE_INET
;
477 inet
= &saddr
->u
.inet
;
478 inet
->host
= g_strdup(bindto
);
480 inet
->port
= g_strdup(port
);
482 inet
->port
= g_strdup_printf("%d", NBD_DEFAULT_PORT
);
490 static QemuOptsList file_opts
= {
492 .implied_opt_name
= "file",
493 .head
= QTAILQ_HEAD_INITIALIZER(file_opts
.head
),
495 /* no elements => accept any params */
496 { /* end of list */ }
500 static QemuOptsList qemu_object_opts
= {
502 .implied_opt_name
= "qom-type",
503 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
511 static QCryptoTLSCreds
*nbd_get_tls_creds(const char *id
, bool list
,
515 QCryptoTLSCreds
*creds
;
517 obj
= object_resolve_path_component(
518 object_get_objects_root(), id
);
520 error_setg(errp
, "No TLS credentials with id '%s'",
524 creds
= (QCryptoTLSCreds
*)
525 object_dynamic_cast(obj
, TYPE_QCRYPTO_TLS_CREDS
);
527 error_setg(errp
, "Object with id '%s' is not TLS credentials",
533 if (creds
->endpoint
!= QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT
) {
535 "Expecting TLS credentials with a client endpoint");
539 if (creds
->endpoint
!= QCRYPTO_TLS_CREDS_ENDPOINT_SERVER
) {
541 "Expecting TLS credentials with a server endpoint");
549 static void setup_address_and_port(const char **address
, const char **port
)
551 if (*address
== NULL
) {
552 *address
= "0.0.0.0";
556 *port
= stringify(NBD_DEFAULT_PORT
);
561 * Check socket parameters compatibility when socket activation is used.
563 static const char *socket_activation_validate_opts(const char *device
,
564 const char *sockpath
,
569 if (device
!= NULL
) {
570 return "NBD device can't be set when using socket activation";
573 if (sockpath
!= NULL
) {
574 return "Unix socket can't be set when using socket activation";
577 if (address
!= NULL
) {
578 return "The interface can't be set when using socket activation";
582 return "TCP port number can't be set when using socket activation";
586 return "List mode is incompatible with socket activation";
592 static void qemu_nbd_shutdown(void)
594 job_cancel_sync_all();
598 int main(int argc
, char **argv
)
601 BlockDriverState
*bs
;
602 uint64_t dev_offset
= 0;
603 uint16_t nbdflags
= 0;
604 bool disconnect
= false;
605 const char *bindto
= NULL
;
606 const char *port
= NULL
;
607 char *sockpath
= NULL
;
610 QemuOpts
*sn_opts
= NULL
;
611 const char *sn_id_or_name
= NULL
;
612 const char *sopt
= "hVb:o:p:rsnP:c:dvk:e:f:tl:x:T:D:B:L";
613 struct option lopt
[] = {
614 { "help", no_argument
, NULL
, 'h' },
615 { "version", no_argument
, NULL
, 'V' },
616 { "bind", required_argument
, NULL
, 'b' },
617 { "port", required_argument
, NULL
, 'p' },
618 { "socket", required_argument
, NULL
, 'k' },
619 { "offset", required_argument
, NULL
, 'o' },
620 { "read-only", no_argument
, NULL
, 'r' },
621 { "partition", required_argument
, NULL
, 'P' },
622 { "bitmap", required_argument
, NULL
, 'B' },
623 { "connect", required_argument
, NULL
, 'c' },
624 { "disconnect", no_argument
, NULL
, 'd' },
625 { "list", no_argument
, NULL
, 'L' },
626 { "snapshot", no_argument
, NULL
, 's' },
627 { "load-snapshot", required_argument
, NULL
, 'l' },
628 { "nocache", no_argument
, NULL
, 'n' },
629 { "cache", required_argument
, NULL
, QEMU_NBD_OPT_CACHE
},
630 { "aio", required_argument
, NULL
, QEMU_NBD_OPT_AIO
},
631 { "discard", required_argument
, NULL
, QEMU_NBD_OPT_DISCARD
},
632 { "detect-zeroes", required_argument
, NULL
,
633 QEMU_NBD_OPT_DETECT_ZEROES
},
634 { "shared", required_argument
, NULL
, 'e' },
635 { "format", required_argument
, NULL
, 'f' },
636 { "persistent", no_argument
, NULL
, 't' },
637 { "verbose", no_argument
, NULL
, 'v' },
638 { "object", required_argument
, NULL
, QEMU_NBD_OPT_OBJECT
},
639 { "export-name", required_argument
, NULL
, 'x' },
640 { "description", required_argument
, NULL
, 'D' },
641 { "tls-creds", required_argument
, NULL
, QEMU_NBD_OPT_TLSCREDS
},
642 { "tls-authz", required_argument
, NULL
, QEMU_NBD_OPT_TLSAUTHZ
},
643 { "image-opts", no_argument
, NULL
, QEMU_NBD_OPT_IMAGE_OPTS
},
644 { "trace", required_argument
, NULL
, 'T' },
645 { "fork", no_argument
, NULL
, QEMU_NBD_OPT_FORK
},
646 { "pid-file", required_argument
, NULL
, QEMU_NBD_OPT_PID_FILE
},
651 int flags
= BDRV_O_RDWR
;
654 bool seen_cache
= false;
655 bool seen_discard
= false;
656 bool seen_aio
= false;
657 pthread_t client_thread
;
658 const char *fmt
= NULL
;
659 Error
*local_err
= NULL
;
660 BlockdevDetectZeroesOptions detect_zeroes
= BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
;
661 QDict
*options
= NULL
;
662 const char *export_name
= NULL
; /* defaults to "" later for server mode */
663 const char *export_description
= NULL
;
664 const char *bitmap
= NULL
;
665 const char *tlscredsid
= NULL
;
666 bool imageOpts
= false;
667 bool writethrough
= true;
668 char *trace_file
= NULL
;
669 bool fork_process
= false;
672 unsigned socket_activation
;
673 const char *pid_file_name
= NULL
;
675 /* The client thread uses SIGTERM to interrupt the server. A signal
676 * handler ensures that "qemu-nbd -v -c" exits with a nice status code.
678 struct sigaction sa_sigterm
;
679 memset(&sa_sigterm
, 0, sizeof(sa_sigterm
));
680 sa_sigterm
.sa_handler
= termsig_handler
;
681 sigaction(SIGTERM
, &sa_sigterm
, NULL
);
684 signal(SIGPIPE
, SIG_IGN
);
688 module_call_init(MODULE_INIT_TRACE
);
689 qcrypto_init(&error_fatal
);
691 module_call_init(MODULE_INIT_QOM
);
692 qemu_add_opts(&qemu_object_opts
);
693 qemu_add_opts(&qemu_trace_opts
);
694 qemu_init_exec_dir(argv
[0]);
696 while ((ch
= getopt_long(argc
, argv
, sopt
, lopt
, &opt_ind
)) != -1) {
699 flags
|= BDRV_O_SNAPSHOT
;
702 optarg
= (char *) "none";
704 case QEMU_NBD_OPT_CACHE
:
706 error_report("-n and --cache can only be specified once");
710 if (bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
) == -1) {
711 error_report("Invalid cache mode `%s'", optarg
);
715 case QEMU_NBD_OPT_AIO
:
717 error_report("--aio can only be specified once");
721 if (!strcmp(optarg
, "native")) {
722 flags
|= BDRV_O_NATIVE_AIO
;
723 } else if (!strcmp(optarg
, "threads")) {
724 /* this is the default */
726 error_report("invalid aio mode `%s'", optarg
);
730 case QEMU_NBD_OPT_DISCARD
:
732 error_report("--discard can only be specified once");
736 if (bdrv_parse_discard_flags(optarg
, &flags
) == -1) {
737 error_report("Invalid discard mode `%s'", optarg
);
741 case QEMU_NBD_OPT_DETECT_ZEROES
:
743 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup
,
745 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF
,
748 error_reportf_err(local_err
,
749 "Failed to parse detect_zeroes mode: ");
752 if (detect_zeroes
== BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP
&&
753 !(flags
& BDRV_O_UNMAP
)) {
754 error_report("setting detect-zeroes to unmap is not allowed "
755 "without setting discard operation to unmap");
766 if (qemu_strtou64(optarg
, NULL
, 0, &dev_offset
) < 0) {
767 error_report("Invalid offset '%s'", optarg
);
772 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
773 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
776 error_report("Failed in parsing snapshot param `%s'",
781 sn_id_or_name
= optarg
;
785 nbdflags
|= NBD_FLAG_READ_ONLY
;
786 flags
&= ~BDRV_O_RDWR
;
789 warn_report("The '-P' option is deprecated; use --image-opts with "
790 "a raw device wrapper for subset exports instead");
791 if (qemu_strtoi(optarg
, NULL
, 0, &partition
) < 0 ||
792 partition
< 1 || partition
> 8) {
793 error_report("Invalid partition '%s'", optarg
);
802 if (sockpath
[0] != '/') {
803 error_report("socket path must be absolute");
814 if (qemu_strtoi(optarg
, NULL
, 0, &shared
) < 0 ||
816 error_report("Invalid shared device number '%s'", optarg
);
827 export_name
= optarg
;
830 export_description
= optarg
;
844 error_report("Try `%s --help' for more information.", argv
[0]);
846 case QEMU_NBD_OPT_OBJECT
: {
848 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
854 case QEMU_NBD_OPT_TLSCREDS
:
857 case QEMU_NBD_OPT_IMAGE_OPTS
:
862 trace_file
= trace_opt_parse(optarg
);
864 case QEMU_NBD_OPT_TLSAUTHZ
:
867 case QEMU_NBD_OPT_FORK
:
873 case QEMU_NBD_OPT_PID_FILE
:
874 pid_file_name
= optarg
;
880 if (argc
!= optind
) {
881 error_report("List mode is incompatible with a file name");
884 if (export_name
|| export_description
|| dev_offset
|| partition
||
885 device
|| disconnect
|| fmt
|| sn_id_or_name
|| bitmap
||
886 seen_aio
|| seen_discard
|| seen_cache
) {
887 error_report("List mode is incompatible with per-device settings");
891 error_report("List mode is incompatible with forking");
894 } else if ((argc
- optind
) != 1) {
895 error_report("Invalid number of arguments");
896 error_printf("Try `%s --help' for more information.\n", argv
[0]);
898 } else if (!export_name
) {
902 qemu_opts_foreach(&qemu_object_opts
,
903 user_creatable_add_opts_foreach
,
906 if (!trace_init_backends()) {
909 trace_init_file(trace_file
);
910 qemu_set_log(LOG_TRACE
);
912 socket_activation
= check_socket_activation();
913 if (socket_activation
== 0) {
914 setup_address_and_port(&bindto
, &port
);
916 /* Using socket activation - check user didn't use -p etc. */
917 const char *err_msg
= socket_activation_validate_opts(device
, sockpath
,
920 if (err_msg
!= NULL
) {
921 error_report("%s", err_msg
);
925 /* qemu-nbd can only listen on a single socket. */
926 if (socket_activation
> 1) {
927 error_report("qemu-nbd does not support socket activation with %s > 1",
935 error_report("TLS is only supported with IPv4/IPv6");
939 error_report("TLS is not supported with a host device");
942 if (tlsauthz
&& list
) {
943 error_report("TLS authorization is incompatible with export list");
946 tlscreds
= nbd_get_tls_creds(tlscredsid
, list
, &local_err
);
948 error_report("Failed to get TLS creds %s",
949 error_get_pretty(local_err
));
954 error_report("--tls-authz is not permitted without --tls-creds");
960 saddr
= nbd_build_socket_address(sockpath
, bindto
, port
);
961 return qemu_nbd_client_list(saddr
, tlscreds
, bindto
);
965 if (disconnect
|| device
) {
966 error_report("Kernel /dev/nbdN support not available");
969 #else /* HAVE_NBD_DEVICE */
971 int nbdfd
= open(argv
[optind
], O_RDWR
);
973 error_report("Cannot open %s: %s", argv
[optind
],
977 nbd_disconnect(nbdfd
);
981 printf("%s disconnected\n", argv
[optind
]);
987 if ((device
&& !verbose
) || fork_process
) {
992 if (qemu_pipe(stderr_fd
) < 0) {
993 error_report("Error setting up communication pipe: %s",
998 /* Now daemonize, but keep a communication channel open to
999 * print errors and exit with the proper status code.
1003 error_report("Failed to fork: %s", strerror(errno
));
1005 } else if (pid
== 0) {
1006 close(stderr_fd
[0]);
1008 old_stderr
= dup(STDERR_FILENO
);
1009 ret
= qemu_daemon(1, 0);
1011 /* Temporarily redirect stderr to the parent's pipe... */
1012 dup2(stderr_fd
[1], STDERR_FILENO
);
1014 error_report("Failed to daemonize: %s", strerror(errno
));
1018 /* ... close the descriptor we inherited and go on. */
1019 close(stderr_fd
[1]);
1021 bool errors
= false;
1024 /* In the parent. Print error messages from the child until
1025 * it closes the pipe.
1027 close(stderr_fd
[1]);
1028 buf
= g_malloc(1024);
1029 while ((ret
= read(stderr_fd
[0], buf
, 1024)) > 0) {
1031 ret
= qemu_write_full(STDERR_FILENO
, buf
, ret
);
1037 error_report("Cannot read from daemon: %s",
1042 /* Usually the daemon should not print any message.
1043 * Exit with zero status in that case.
1049 if (device
!= NULL
&& sockpath
== NULL
) {
1050 sockpath
= g_malloc(128);
1051 snprintf(sockpath
, 128, SOCKET_PATH
, basename(device
));
1054 server
= qio_net_listener_new();
1055 if (socket_activation
== 0) {
1056 saddr
= nbd_build_socket_address(sockpath
, bindto
, port
);
1057 if (qio_net_listener_open_sync(server
, saddr
, &local_err
) < 0) {
1058 object_unref(OBJECT(server
));
1059 error_report_err(local_err
);
1064 /* See comment in check_socket_activation above. */
1065 for (i
= 0; i
< socket_activation
; i
++) {
1066 QIOChannelSocket
*sioc
;
1067 sioc
= qio_channel_socket_new_fd(FIRST_SOCKET_ACTIVATION_FD
+ i
,
1070 object_unref(OBJECT(server
));
1071 error_report("Failed to use socket activation: %s",
1072 error_get_pretty(local_err
));
1075 qio_net_listener_add(server
, sioc
);
1076 object_unref(OBJECT(sioc
));
1080 if (qemu_init_main_loop(&local_err
)) {
1081 error_report_err(local_err
);
1085 atexit(qemu_nbd_shutdown
);
1087 srcpath
= argv
[optind
];
1091 error_report("--image-opts and -f are mutually exclusive");
1094 opts
= qemu_opts_parse_noisily(&file_opts
, srcpath
, true);
1096 qemu_opts_reset(&file_opts
);
1099 options
= qemu_opts_to_qdict(opts
, NULL
);
1100 qemu_opts_reset(&file_opts
);
1101 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
1104 options
= qdict_new();
1105 qdict_put_str(options
, "driver", fmt
);
1107 blk
= blk_new_open(srcpath
, NULL
, options
, flags
, &local_err
);
1111 error_reportf_err(local_err
, "Failed to blk_new_open '%s': ",
1117 blk_set_enable_write_cache(blk
, !writethrough
);
1120 ret
= bdrv_snapshot_load_tmp(bs
,
1121 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1122 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1124 } else if (sn_id_or_name
) {
1125 ret
= bdrv_snapshot_load_tmp_by_id_or_name(bs
, sn_id_or_name
,
1129 error_reportf_err(local_err
, "Failed to load snapshot: ");
1133 bs
->detect_zeroes
= detect_zeroes
;
1134 fd_size
= blk_getlength(blk
);
1136 error_report("Failed to determine the image length: %s",
1137 strerror(-fd_size
));
1141 if (dev_offset
>= fd_size
) {
1142 error_report("Offset (%" PRIu64
") has to be smaller than the image "
1143 "size (%" PRId64
")", dev_offset
, fd_size
);
1146 fd_size
-= dev_offset
;
1152 error_report("Cannot request partition and offset together");
1155 ret
= find_partition(blk
, partition
, &dev_offset
, &limit
);
1157 error_report("Could not find partition %d: %s", partition
,
1162 * MBR partition limits are (32-bit << 9); this assert lets
1163 * the compiler know that we can't overflow 64 bits.
1165 assert(dev_offset
+ limit
>= dev_offset
);
1166 if (dev_offset
+ limit
> fd_size
) {
1167 error_report("Discovered partition %d at offset %" PRIu64
1168 " size %" PRIu64
", but size exceeds file length %"
1169 PRId64
, partition
, dev_offset
, limit
, fd_size
);
1175 export
= nbd_export_new(bs
, dev_offset
, fd_size
, export_name
,
1176 export_description
, bitmap
, nbdflags
,
1177 nbd_export_closed
, writethrough
, NULL
,
1184 ret
= pthread_create(&client_thread
, NULL
, nbd_client_thread
, device
);
1186 error_report("Failed to create client thread: %s", strerror(ret
));
1191 /* Shut up GCC warnings. */
1192 memset(&client_thread
, 0, sizeof(client_thread
));
1195 nbd_update_server_watch();
1197 if (pid_file_name
) {
1198 qemu_write_pidfile(pid_file_name
, &error_fatal
);
1201 /* now when the initialization is (almost) complete, chdir("/")
1202 * to free any busy filesystems */
1203 if (chdir("/") < 0) {
1204 error_report("Could not chdir to root directory: %s",
1210 dup2(old_stderr
, STDERR_FILENO
);
1216 main_loop_wait(false);
1217 if (state
== TERMINATE
) {
1218 state
= TERMINATING
;
1219 nbd_export_close(export
);
1220 nbd_export_put(export
);
1223 } while (state
!= TERMINATED
);
1230 qemu_opts_del(sn_opts
);
1234 pthread_join(client_thread
, &ret
);