]> git.proxmox.com Git - mirror_qemu.git/blame - qemu-nbd.c
util/vfio-helpers: Rework the IOVA allocator to avoid IOVA reserved regions
[mirror_qemu.git] / qemu-nbd.c
CommitLineData
cd831bd7 1/*
7a5ca864
FB
2 * Copyright (C) 2005 Anthony Liguori <anthony@codemonkey.ws>
3 *
4 * Network Block Device
5 *
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.
9 *
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.
14 *
15 * You should have received a copy of the GNU General Public License
8167ee88 16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
7a5ca864
FB
17 */
18
d38ea87a 19#include "qemu/osdep.h"
c2a3d7da
EB
20#include <getopt.h>
21#include <libgen.h>
22#include <pthread.h>
23
a8d25326 24#include "qemu-common.h"
da34e65c 25#include "qapi/error.h"
f348b6d1 26#include "qemu/cutils.h"
26f54e9a 27#include "sysemu/block-backend.h"
b3838a40 28#include "block/block_int.h"
737e150e 29#include "block/nbd.h"
6a1751b7 30#include "qemu/main-loop.h"
0b8fa32f 31#include "qemu/module.h"
922a01a0 32#include "qemu/option.h"
537b41f5 33#include "qemu/error-report.h"
0ab3b337 34#include "qemu/config-file.h"
58369e22 35#include "qemu/bswap.h"
39ca463e 36#include "qemu/log.h"
53fabd4b 37#include "qemu/systemd.h"
8c116b0e 38#include "block/snapshot.h"
452fcdbc 39#include "qapi/qmp/qdict.h"
d49b6836 40#include "qapi/qmp/qstring.h"
0ab3b337 41#include "qom/object_interfaces.h"
d0d6ff58 42#include "io/channel-socket.h"
e4849c1d 43#include "io/net-listener.h"
c2297088 44#include "crypto/init.h"
39ca463e 45#include "trace/control.h"
be377133 46#include "qemu-version.h"
7a5ca864 47
3c1fa35d
EB
48#ifdef __linux__
49#define HAVE_NBD_DEVICE 1
50#else
51#define HAVE_NBD_DEVICE 0
52#endif
53
713cc671 54#define SOCKET_PATH "/var/lock/qemu-nbd-%s"
fa8b7ce2
DB
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
ffb31e1d 62#define QEMU_NBD_OPT_FORK 263
b25e12da 63#define QEMU_NBD_OPT_TLSAUTHZ 264
637bc5a5 64#define QEMU_NBD_OPT_PID_FILE 265
7a5ca864 65
bd31c214
EB
66#define MBR_SIZE 512
67
b1d8e52e 68static int verbose;
a517e88b 69static char *srcpath;
bd269ebc 70static SocketAddress *saddr;
7860a380 71static int persistent = 0;
d794f7f3 72static enum { RUNNING, TERMINATE, TERMINATED } state;
a61c6782
PB
73static int shared = 1;
74static int nb_fds;
e4849c1d 75static QIONetListener *server;
145614a1 76static QCryptoTLSCreds *tlscreds;
b25e12da 77static const char *tlsauthz;
7a5ca864
FB
78
79static void usage(const char *name)
80{
b033cd86 81 (printf) (
7a5ca864 82"Usage: %s [OPTIONS] FILE\n"
68b96f15
EB
83" or: %s -L [OPTIONS]\n"
84"QEMU Disk Network Block Device Utility\n"
7a5ca864 85"\n"
713cc671
PL
86" -h, --help display this help and exit\n"
87" -V, --version output version information and exit\n"
b033cd86
PB
88"\n"
89"Connection properties:\n"
713cc671
PL
90" -p, --port=PORT port to listen on (default `%d')\n"
91" -b, --bind=IFACE interface to bind to (default `0.0.0.0')\n"
92" -k, --socket=PATH path to the unix socket\n"
93" (default '"SOCKET_PATH"')\n"
94" -e, --shared=NUM device can be shared by NUM clients (default '1')\n"
95" -t, --persistent don't exit on the last connection\n"
96" -v, --verbose display extra debugging information\n"
f5cd0bb5
VSO
97" -x, --export-name=NAME expose export by name (default is empty string)\n"
98" -D, --description=TEXT export a human-readable description\n"
7a5ca864 99"\n"
b033cd86 100"Exposing part of the image:\n"
713cc671 101" -o, --offset=OFFSET offset into the image\n"
636192c4 102" -B, --bitmap=NAME expose a persistent dirty bitmap\n"
b033cd86 103"\n"
0ab3b337 104"General purpose options:\n"
68b96f15 105" -L, --list list exports available from another NBD server\n"
0ab3b337
DB
106" --object type,id=ID,... define an object such as 'secret' for providing\n"
107" passwords and/or encryption keys\n"
f7812df7 108" --tls-creds=ID use id of an earlier --object to provide TLS\n"
b25e12da
DB
109" --tls-authz=ID use id of an earlier --object to provide\n"
110" authorization\n"
39ca463e
DL
111" -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
112" specify tracing options\n"
ffb31e1d
HR
113" --fork fork off the server process and exit the parent\n"
114" once the server is running\n"
637bc5a5 115" --pid-file=PATH store the server's process ID in the given file\n"
3c1fa35d
EB
116#if HAVE_NBD_DEVICE
117"\n"
b033cd86 118"Kernel NBD client support:\n"
713cc671
PL
119" -c, --connect=DEV connect FILE to the local NBD device DEV\n"
120" -d, --disconnect disconnect the specified device\n"
b033cd86
PB
121#endif
122"\n"
123"Block device options:\n"
713cc671
PL
124" -f, --format=FORMAT set image format (raw, qcow2, ...)\n"
125" -r, --read-only export read-only\n"
126" -s, --snapshot use FILE as an external snapshot, create a temporary\n"
127" file with backing_file=FILE, redirect the write to\n"
128" the temporary one\n"
8c116b0e 129" -l, --load-snapshot=SNAPSHOT_PARAM\n"
713cc671
PL
130" load an internal snapshot inside FILE and export it\n"
131" as an read-only device, SNAPSHOT_PARAM format is\n"
132" 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
133" '[ID_OR_NAME]'\n"
134" -n, --nocache disable host cache\n"
135" --cache=MODE set cache mode (none, writeback, ...)\n"
7680274d 136" --aio=MODE set AIO mode (native, io_uring or threads)\n"
b3838a40 137" --discard=MODE set discard mode (ignore, unmap)\n"
6883de6c 138" --detect-zeroes=MODE set detect-zeroes mode (off, on, unmap)\n"
77c9aaef 139" --image-opts treat FILE as a full set of image options\n"
b033cd86 140"\n"
f5048cb7 141QEMU_HELP_BOTTOM "\n"
68b96f15 142 , name, name, NBD_DEFAULT_PORT, "DEVICE");
7a5ca864
FB
143}
144
145static void version(const char *name)
146{
147 printf(
7e563bfb 148"%s " QEMU_FULL_VERSION "\n"
7a5ca864
FB
149"Written by Anthony Liguori.\n"
150"\n"
be377133 151QEMU_COPYRIGHT "\n"
7a5ca864
FB
152"This is free software; see the source for copying conditions. There is NO\n"
153"warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
315bc7aa 154 , name);
7a5ca864
FB
155}
156
6e64dd57 157#if HAVE_NBD_DEVICE
bb345110
PB
158static void termsig_handler(int signum)
159{
d73415a3 160 qatomic_cmpxchg(&state, RUNNING, TERMINATE);
a61c6782 161 qemu_notify_event();
bb345110 162}
6e64dd57 163#endif /* HAVE_NBD_DEVICE */
537b41f5 164
68b96f15
EB
165static int qemu_nbd_client_list(SocketAddress *saddr, QCryptoTLSCreds *tls,
166 const char *hostname)
167{
168 int ret = EXIT_FAILURE;
169 int rc;
170 Error *err = NULL;
171 QIOChannelSocket *sioc;
172 NBDExportInfo *list;
173 int i, j;
174
175 sioc = qio_channel_socket_new();
176 if (qio_channel_socket_connect_sync(sioc, saddr, &err) < 0) {
177 error_report_err(err);
178 return EXIT_FAILURE;
179 }
180 rc = nbd_receive_export_list(QIO_CHANNEL(sioc), tls, hostname, &list,
181 &err);
182 if (rc < 0) {
183 if (err) {
184 error_report_err(err);
185 }
186 goto out;
187 }
188 printf("exports available: %d\n", rc);
189 for (i = 0; i < rc; i++) {
190 printf(" export: '%s'\n", list[i].name);
191 if (list[i].description && *list[i].description) {
192 printf(" description: %s\n", list[i].description);
193 }
194 if (list[i].flags & NBD_FLAG_HAS_FLAGS) {
c4e2aff8
HR
195 static const char *const flag_names[] = {
196 [NBD_FLAG_READ_ONLY_BIT] = "readonly",
197 [NBD_FLAG_SEND_FLUSH_BIT] = "flush",
198 [NBD_FLAG_SEND_FUA_BIT] = "fua",
199 [NBD_FLAG_ROTATIONAL_BIT] = "rotational",
200 [NBD_FLAG_SEND_TRIM_BIT] = "trim",
201 [NBD_FLAG_SEND_WRITE_ZEROES_BIT] = "zeroes",
202 [NBD_FLAG_SEND_DF_BIT] = "df",
203 [NBD_FLAG_CAN_MULTI_CONN_BIT] = "multi",
204 [NBD_FLAG_SEND_RESIZE_BIT] = "resize",
205 [NBD_FLAG_SEND_CACHE_BIT] = "cache",
0a479545 206 [NBD_FLAG_SEND_FAST_ZERO_BIT] = "fast-zero",
c4e2aff8
HR
207 };
208
68b96f15
EB
209 printf(" size: %" PRIu64 "\n", list[i].size);
210 printf(" flags: 0x%x (", list[i].flags);
c4e2aff8
HR
211 for (size_t bit = 0; bit < ARRAY_SIZE(flag_names); bit++) {
212 if (flag_names[bit] && (list[i].flags & (1 << bit))) {
213 printf(" %s", flag_names[bit]);
214 }
68b96f15
EB
215 }
216 printf(" )\n");
217 }
218 if (list[i].min_block) {
219 printf(" min block: %u\n", list[i].min_block);
220 printf(" opt block: %u\n", list[i].opt_block);
221 printf(" max block: %u\n", list[i].max_block);
222 }
223 if (list[i].n_contexts) {
224 printf(" available meta contexts: %d\n", list[i].n_contexts);
225 for (j = 0; j < list[i].n_contexts; j++) {
226 printf(" %s\n", list[i].contexts[j]);
227 }
228 }
229 }
230 nbd_free_export_list(list, rc);
231
232 ret = EXIT_SUCCESS;
233 out:
234 object_unref(OBJECT(sioc));
235 return ret;
236}
237
238
3c1fa35d 239#if HAVE_NBD_DEVICE
a517e88b 240static void *show_parts(void *arg)
cd831bd7 241{
a6ac2313 242 char *device = arg;
a517e88b
PB
243 int nbd;
244
245 /* linux just needs an open() to trigger
246 * the partition table update
247 * but remember to load the module with max_part != 0 :
248 * modprobe nbd max_part=63
249 */
250 nbd = open(device, O_RDWR);
fc19f8a0 251 if (nbd >= 0) {
a517e88b
PB
252 close(nbd);
253 }
254 return NULL;
255}
cd831bd7 256
a517e88b
PB
257static void *nbd_client_thread(void *arg)
258{
a6ac2313 259 char *device = arg;
6dc1667d 260 NBDExportInfo info = { .request_sizes = false, .name = g_strdup("") };
d0d6ff58
DB
261 QIOChannelSocket *sioc;
262 int fd;
a517e88b
PB
263 int ret;
264 pthread_t show_parts_thread;
1ce52846 265 Error *local_error = NULL;
a517e88b 266
d0d6ff58
DB
267 sioc = qio_channel_socket_new();
268 if (qio_channel_socket_connect_sync(sioc,
269 saddr,
270 &local_error) < 0) {
48bec07e 271 error_report_err(local_error);
dc10e8b3
SH
272 goto out;
273 }
a517e88b 274
a8e2bb6a 275 ret = nbd_receive_negotiate(NULL, QIO_CHANNEL(sioc),
004a89fc 276 NULL, NULL, NULL, &info, &local_error);
fc19f8a0 277 if (ret < 0) {
1ce52846 278 if (local_error) {
78288671 279 error_report_err(local_error);
1ce52846 280 }
0c544d73 281 goto out_socket;
a517e88b
PB
282 }
283
a6ac2313 284 fd = open(device, O_RDWR);
fc19f8a0 285 if (fd < 0) {
a6ac2313 286 /* Linux-only, we can use %m in printf. */
b9884681 287 error_report("Failed to open %s: %m", device);
0c544d73 288 goto out_socket;
a6ac2313
PB
289 }
290
004a89fc 291 ret = nbd_init(fd, sioc, &info, &local_error);
fc19f8a0 292 if (ret < 0) {
be41c100 293 error_report_err(local_error);
0c544d73 294 goto out_fd;
a517e88b
PB
295 }
296
297 /* update partition table */
a6ac2313 298 pthread_create(&show_parts_thread, NULL, show_parts, device);
a517e88b 299
c1f8fdc3
PB
300 if (verbose) {
301 fprintf(stderr, "NBD device %s is now connected to %s\n",
302 device, srcpath);
303 } else {
304 /* Close stderr so that the qemu-nbd process exits. */
305 dup2(STDOUT_FILENO, STDERR_FILENO);
306 }
a517e88b
PB
307
308 ret = nbd_client(fd);
309 if (ret) {
0c544d73 310 goto out_fd;
cd831bd7 311 }
a517e88b 312 close(fd);
d0d6ff58 313 object_unref(OBJECT(sioc));
6dc1667d 314 g_free(info.name);
a517e88b
PB
315 kill(getpid(), SIGTERM);
316 return (void *) EXIT_SUCCESS;
317
0c544d73
PB
318out_fd:
319 close(fd);
320out_socket:
d0d6ff58 321 object_unref(OBJECT(sioc));
a517e88b 322out:
6dc1667d 323 g_free(info.name);
a517e88b
PB
324 kill(getpid(), SIGTERM);
325 return (void *) EXIT_FAILURE;
cd831bd7 326}
3c1fa35d 327#endif /* HAVE_NBD_DEVICE */
cd831bd7 328
e4afbf4f 329static int nbd_can_accept(void)
a61c6782 330{
df8ad9f1 331 return state == RUNNING && nb_fds < shared;
a61c6782
PB
332}
333
d0d6ff58 334static void nbd_update_server_watch(void);
e4afbf4f 335
0c9390d9 336static void nbd_client_closed(NBDClient *client, bool negotiated)
a61c6782 337{
1743b515 338 nb_fds--;
0c9390d9 339 if (negotiated && nb_fds == 0 && !persistent && state == RUNNING) {
7860a380
PB
340 state = TERMINATE;
341 }
d0d6ff58 342 nbd_update_server_watch();
7860a380 343 nbd_client_put(client);
a61c6782
PB
344}
345
e4849c1d
DB
346static void nbd_accept(QIONetListener *listener, QIOChannelSocket *cioc,
347 gpointer opaque)
a61c6782 348{
7860a380 349 if (state >= TERMINATE) {
e4849c1d 350 return;
7860a380
PB
351 }
352
ee7d7aab 353 nb_fds++;
d0d6ff58 354 nbd_update_server_watch();
b25e12da 355 nbd_client_new(cioc, tlscreds, tlsauthz, nbd_client_closed);
a61c6782
PB
356}
357
d0d6ff58 358static void nbd_update_server_watch(void)
e4afbf4f
FZ
359{
360 if (nbd_can_accept()) {
e4849c1d 361 qio_net_listener_set_client_func(server, nbd_accept, NULL, NULL);
e4afbf4f 362 } else {
e4849c1d 363 qio_net_listener_set_client_func(server, NULL, NULL, NULL);
e4afbf4f
FZ
364 }
365}
366
48bec07e 367
bd269ebc 368static SocketAddress *nbd_build_socket_address(const char *sockpath,
48bec07e
DB
369 const char *bindto,
370 const char *port)
371{
bd269ebc 372 SocketAddress *saddr;
48bec07e 373
bd269ebc 374 saddr = g_new0(SocketAddress, 1);
48bec07e 375 if (sockpath) {
bd269ebc
MA
376 saddr->type = SOCKET_ADDRESS_TYPE_UNIX;
377 saddr->u.q_unix.path = g_strdup(sockpath);
48bec07e 378 } else {
0399293e 379 InetSocketAddress *inet;
bd269ebc
MA
380 saddr->type = SOCKET_ADDRESS_TYPE_INET;
381 inet = &saddr->u.inet;
0399293e 382 inet->host = g_strdup(bindto);
48bec07e 383 if (port) {
0399293e 384 inet->port = g_strdup(port);
48bec07e 385 } else {
0399293e 386 inet->port = g_strdup_printf("%d", NBD_DEFAULT_PORT);
48bec07e
DB
387 }
388 }
389
390 return saddr;
391}
392
393
77c9aaef
DB
394static QemuOptsList file_opts = {
395 .name = "file",
396 .implied_opt_name = "file",
397 .head = QTAILQ_HEAD_INITIALIZER(file_opts.head),
398 .desc = {
399 /* no elements => accept any params */
400 { /* end of list */ }
401 },
402};
403
0ab3b337
DB
404static QemuOptsList qemu_object_opts = {
405 .name = "object",
406 .implied_opt_name = "qom-type",
407 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
408 .desc = {
409 { }
410 },
411};
412
495bf893
KW
413static bool qemu_nbd_object_print_help(const char *type, QemuOpts *opts)
414{
415 if (user_creatable_print_help(type, opts)) {
416 exit(0);
417 }
418 return true;
419}
0ab3b337 420
145614a1 421
68b96f15
EB
422static QCryptoTLSCreds *nbd_get_tls_creds(const char *id, bool list,
423 Error **errp)
145614a1
DB
424{
425 Object *obj;
426 QCryptoTLSCreds *creds;
427
428 obj = object_resolve_path_component(
429 object_get_objects_root(), id);
430 if (!obj) {
431 error_setg(errp, "No TLS credentials with id '%s'",
432 id);
433 return NULL;
434 }
435 creds = (QCryptoTLSCreds *)
436 object_dynamic_cast(obj, TYPE_QCRYPTO_TLS_CREDS);
437 if (!creds) {
438 error_setg(errp, "Object with id '%s' is not TLS credentials",
439 id);
440 return NULL;
441 }
442
68b96f15
EB
443 if (list) {
444 if (creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
445 error_setg(errp,
446 "Expecting TLS credentials with a client endpoint");
447 return NULL;
448 }
449 } else {
450 if (creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
451 error_setg(errp,
452 "Expecting TLS credentials with a server endpoint");
453 return NULL;
454 }
145614a1
DB
455 }
456 object_ref(obj);
457 return creds;
458}
459
a721f53b
RJ
460static void setup_address_and_port(const char **address, const char **port)
461{
462 if (*address == NULL) {
463 *address = "0.0.0.0";
464 }
465
466 if (*port == NULL) {
467 *port = stringify(NBD_DEFAULT_PORT);
468 }
469}
470
a721f53b
RJ
471/*
472 * Check socket parameters compatibility when socket activation is used.
473 */
474static const char *socket_activation_validate_opts(const char *device,
475 const char *sockpath,
476 const char *address,
68b96f15
EB
477 const char *port,
478 bool list)
a721f53b
RJ
479{
480 if (device != NULL) {
481 return "NBD device can't be set when using socket activation";
482 }
483
484 if (sockpath != NULL) {
485 return "Unix socket can't be set when using socket activation";
486 }
487
488 if (address != NULL) {
489 return "The interface can't be set when using socket activation";
490 }
491
492 if (port != NULL) {
493 return "TCP port number can't be set when using socket activation";
494 }
495
68b96f15
EB
496 if (list) {
497 return "List mode is incompatible with socket activation";
498 }
499
a721f53b
RJ
500 return NULL;
501}
145614a1 502
b3b5299d
KW
503static void qemu_nbd_shutdown(void)
504{
505 job_cancel_sync_all();
506 bdrv_close_all();
507}
508
7a5ca864
FB
509int main(int argc, char **argv)
510{
26f54e9a 511 BlockBackend *blk;
7a5ca864 512 BlockDriverState *bs;
9d26dfcb 513 uint64_t dev_offset = 0;
dbb38caa 514 bool readonly = false;
cd831bd7 515 bool disconnect = false;
a721f53b 516 const char *bindto = NULL;
48bec07e
DB
517 const char *port = NULL;
518 char *sockpath = NULL;
a6ac2313 519 char *device = NULL;
8c116b0e
WX
520 QemuOpts *sn_opts = NULL;
521 const char *sn_id_or_name = NULL;
0bc16997 522 const char *sopt = "hVb:o:p:rsnc:dvk:e:f:tl:x:T:D:B:L";
7a5ca864 523 struct option lopt[] = {
aa6e546c
DB
524 { "help", no_argument, NULL, 'h' },
525 { "version", no_argument, NULL, 'V' },
526 { "bind", required_argument, NULL, 'b' },
527 { "port", required_argument, NULL, 'p' },
528 { "socket", required_argument, NULL, 'k' },
529 { "offset", required_argument, NULL, 'o' },
530 { "read-only", no_argument, NULL, 'r' },
636192c4 531 { "bitmap", required_argument, NULL, 'B' },
aa6e546c
DB
532 { "connect", required_argument, NULL, 'c' },
533 { "disconnect", no_argument, NULL, 'd' },
68b96f15 534 { "list", no_argument, NULL, 'L' },
aa6e546c
DB
535 { "snapshot", no_argument, NULL, 's' },
536 { "load-snapshot", required_argument, NULL, 'l' },
537 { "nocache", no_argument, NULL, 'n' },
538 { "cache", required_argument, NULL, QEMU_NBD_OPT_CACHE },
539 { "aio", required_argument, NULL, QEMU_NBD_OPT_AIO },
540 { "discard", required_argument, NULL, QEMU_NBD_OPT_DISCARD },
541 { "detect-zeroes", required_argument, NULL,
542 QEMU_NBD_OPT_DETECT_ZEROES },
543 { "shared", required_argument, NULL, 'e' },
544 { "format", required_argument, NULL, 'f' },
545 { "persistent", no_argument, NULL, 't' },
546 { "verbose", no_argument, NULL, 'v' },
547 { "object", required_argument, NULL, QEMU_NBD_OPT_OBJECT },
548 { "export-name", required_argument, NULL, 'x' },
b1a75b33 549 { "description", required_argument, NULL, 'D' },
aa6e546c 550 { "tls-creds", required_argument, NULL, QEMU_NBD_OPT_TLSCREDS },
b25e12da 551 { "tls-authz", required_argument, NULL, QEMU_NBD_OPT_TLSAUTHZ },
aa6e546c 552 { "image-opts", no_argument, NULL, QEMU_NBD_OPT_IMAGE_OPTS },
39ca463e 553 { "trace", required_argument, NULL, 'T' },
ffb31e1d 554 { "fork", no_argument, NULL, QEMU_NBD_OPT_FORK },
637bc5a5 555 { "pid-file", required_argument, NULL, QEMU_NBD_OPT_PID_FILE },
660f11be 556 { NULL, 0, NULL, 0 }
7a5ca864
FB
557 };
558 int ch;
559 int opt_ind = 0;
f5edb014 560 int flags = BDRV_O_RDWR;
4fbec260 561 int ret = 0;
39a5235c 562 bool seen_cache = false;
ded9d2d5 563 bool seen_discard = false;
39a5235c 564 bool seen_aio = false;
a517e88b 565 pthread_t client_thread;
e6b63677 566 const char *fmt = NULL;
34b5d2c6 567 Error *local_err = NULL;
b3838a40 568 BlockdevDetectZeroesOptions detect_zeroes = BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
4fbec260 569 QDict *options = NULL;
68b96f15 570 const char *export_name = NULL; /* defaults to "" later for server mode */
b1a75b33 571 const char *export_description = NULL;
636192c4 572 const char *bitmap = NULL;
145614a1 573 const char *tlscredsid = NULL;
77c9aaef 574 bool imageOpts = false;
6effd5bf 575 bool writethrough = true;
39ca463e 576 char *trace_file = NULL;
ffb31e1d 577 bool fork_process = false;
68b96f15 578 bool list = false;
ffb31e1d 579 int old_stderr = -1;
a721f53b 580 unsigned socket_activation;
637bc5a5 581 const char *pid_file_name = NULL;
00917172 582 BlockExportOptions *export_opts;
7a5ca864 583
6e64dd57 584#if HAVE_NBD_DEVICE
a517e88b
PB
585 /* The client thread uses SIGTERM to interrupt the server. A signal
586 * handler ensures that "qemu-nbd -v -c" exits with a nice status code.
587 */
bb345110 588 struct sigaction sa_sigterm;
bb345110
PB
589 memset(&sa_sigterm, 0, sizeof(sa_sigterm));
590 sa_sigterm.sa_handler = termsig_handler;
591 sigaction(SIGTERM, &sa_sigterm, NULL);
6e64dd57 592#endif /* HAVE_NBD_DEVICE */
c2297088 593
041e32b8
HR
594#ifdef CONFIG_POSIX
595 signal(SIGPIPE, SIG_IGN);
596#endif
597
98c5d2e7 598 socket_init();
f5852efa 599 error_init(argv[0]);
fe4db84d 600 module_call_init(MODULE_INIT_TRACE);
e8f2d272 601 qcrypto_init(&error_fatal);
c2297088 602
0ab3b337
DB
603 module_call_init(MODULE_INIT_QOM);
604 qemu_add_opts(&qemu_object_opts);
39ca463e 605 qemu_add_opts(&qemu_trace_opts);
10f5bff6 606 qemu_init_exec_dir(argv[0]);
bb345110 607
7a5ca864
FB
608 while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
609 switch (ch) {
610 case 's':
2f726488
TS
611 flags |= BDRV_O_SNAPSHOT;
612 break;
613 case 'n':
39a5235c
PB
614 optarg = (char *) "none";
615 /* fallthrough */
616 case QEMU_NBD_OPT_CACHE:
617 if (seen_cache) {
85b01e09
MA
618 error_report("-n and --cache can only be specified once");
619 exit(EXIT_FAILURE);
39a5235c
PB
620 }
621 seen_cache = true;
6effd5bf 622 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) == -1) {
85b01e09
MA
623 error_report("Invalid cache mode `%s'", optarg);
624 exit(EXIT_FAILURE);
39a5235c 625 }
7a5ca864 626 break;
39a5235c
PB
627 case QEMU_NBD_OPT_AIO:
628 if (seen_aio) {
85b01e09
MA
629 error_report("--aio can only be specified once");
630 exit(EXIT_FAILURE);
39a5235c
PB
631 }
632 seen_aio = true;
7680274d
AM
633 if (bdrv_parse_aio(optarg, &flags) < 0) {
634 error_report("Invalid aio mode '%s'", optarg);
635 exit(EXIT_FAILURE);
39a5235c
PB
636 }
637 break;
ded9d2d5
PB
638 case QEMU_NBD_OPT_DISCARD:
639 if (seen_discard) {
85b01e09
MA
640 error_report("--discard can only be specified once");
641 exit(EXIT_FAILURE);
ded9d2d5
PB
642 }
643 seen_discard = true;
644 if (bdrv_parse_discard_flags(optarg, &flags) == -1) {
85b01e09
MA
645 error_report("Invalid discard mode `%s'", optarg);
646 exit(EXIT_FAILURE);
ded9d2d5
PB
647 }
648 break;
b3838a40
PL
649 case QEMU_NBD_OPT_DETECT_ZEROES:
650 detect_zeroes =
f7abe0ec 651 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
b3838a40 652 optarg,
b3838a40
PL
653 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
654 &local_err);
655 if (local_err) {
c29b77f9
MA
656 error_reportf_err(local_err,
657 "Failed to parse detect_zeroes mode: ");
85b01e09 658 exit(EXIT_FAILURE);
b3838a40
PL
659 }
660 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
661 !(flags & BDRV_O_UNMAP)) {
85b01e09
MA
662 error_report("setting detect-zeroes to unmap is not allowed "
663 "without setting discard operation to unmap");
664 exit(EXIT_FAILURE);
b3838a40
PL
665 }
666 break;
7a5ca864
FB
667 case 'b':
668 bindto = optarg;
669 break;
670 case 'p':
48bec07e 671 port = optarg;
7a5ca864
FB
672 break;
673 case 'o':
43b51011
EB
674 if (qemu_strtou64(optarg, NULL, 0, &dev_offset) < 0) {
675 error_report("Invalid offset '%s'", optarg);
85b01e09 676 exit(EXIT_FAILURE);
7a5ca864 677 }
7a5ca864 678 break;
8c116b0e
WX
679 case 'l':
680 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
70b94331
MA
681 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
682 optarg, false);
8c116b0e 683 if (!sn_opts) {
85b01e09
MA
684 error_report("Failed in parsing snapshot param `%s'",
685 optarg);
686 exit(EXIT_FAILURE);
8c116b0e
WX
687 }
688 } else {
689 sn_id_or_name = optarg;
690 }
691 /* fall through */
7a5ca864 692 case 'r':
dbb38caa 693 readonly = true;
07108b29 694 flags &= ~BDRV_O_RDWR;
7a5ca864 695 break;
636192c4
EB
696 case 'B':
697 bitmap = optarg;
698 break;
cd831bd7 699 case 'k':
b32f6c28 700 sockpath = optarg;
713cc671 701 if (sockpath[0] != '/') {
9af9e0fe 702 error_report("socket path must be absolute");
85b01e09 703 exit(EXIT_FAILURE);
713cc671 704 }
cd831bd7
TS
705 break;
706 case 'd':
707 disconnect = true;
708 break;
709 case 'c':
710 device = optarg;
711 break;
3b05a8e9 712 case 'e':
43b51011
EB
713 if (qemu_strtoi(optarg, NULL, 0, &shared) < 0 ||
714 shared < 1) {
85b01e09
MA
715 error_report("Invalid shared device number '%s'", optarg);
716 exit(EXIT_FAILURE);
3b05a8e9 717 }
3b05a8e9 718 break;
e6b63677
DB
719 case 'f':
720 fmt = optarg;
721 break;
713cc671
PL
722 case 't':
723 persistent = 1;
724 break;
3d4b2f9c
DB
725 case 'x':
726 export_name = optarg;
93676c88
EB
727 if (strlen(export_name) > NBD_MAX_STRING_SIZE) {
728 error_report("export name '%s' too long", export_name);
729 exit(EXIT_FAILURE);
730 }
3d4b2f9c 731 break;
b1a75b33
EB
732 case 'D':
733 export_description = optarg;
93676c88
EB
734 if (strlen(export_description) > NBD_MAX_STRING_SIZE) {
735 error_report("export description '%s' too long",
736 export_description);
737 exit(EXIT_FAILURE);
738 }
b1a75b33 739 break;
7a5ca864
FB
740 case 'v':
741 verbose = 1;
742 break;
743 case 'V':
744 version(argv[0]);
745 exit(0);
746 break;
747 case 'h':
748 usage(argv[0]);
749 exit(0);
750 break;
751 case '?':
85b01e09
MA
752 error_report("Try `%s --help' for more information.", argv[0]);
753 exit(EXIT_FAILURE);
0ab3b337
DB
754 case QEMU_NBD_OPT_OBJECT: {
755 QemuOpts *opts;
756 opts = qemu_opts_parse_noisily(&qemu_object_opts,
757 optarg, true);
758 if (!opts) {
759 exit(EXIT_FAILURE);
760 }
761 } break;
145614a1
DB
762 case QEMU_NBD_OPT_TLSCREDS:
763 tlscredsid = optarg;
764 break;
77c9aaef
DB
765 case QEMU_NBD_OPT_IMAGE_OPTS:
766 imageOpts = true;
767 break;
39ca463e
DL
768 case 'T':
769 g_free(trace_file);
770 trace_file = trace_opt_parse(optarg);
771 break;
b25e12da
DB
772 case QEMU_NBD_OPT_TLSAUTHZ:
773 tlsauthz = optarg;
774 break;
ffb31e1d
HR
775 case QEMU_NBD_OPT_FORK:
776 fork_process = true;
777 break;
68b96f15
EB
778 case 'L':
779 list = true;
780 break;
637bc5a5
HR
781 case QEMU_NBD_OPT_PID_FILE:
782 pid_file_name = optarg;
783 break;
7a5ca864
FB
784 }
785 }
786
68b96f15
EB
787 if (list) {
788 if (argc != optind) {
789 error_report("List mode is incompatible with a file name");
790 exit(EXIT_FAILURE);
791 }
0bc16997 792 if (export_name || export_description || dev_offset ||
68b96f15
EB
793 device || disconnect || fmt || sn_id_or_name || bitmap ||
794 seen_aio || seen_discard || seen_cache) {
795 error_report("List mode is incompatible with per-device settings");
796 exit(EXIT_FAILURE);
797 }
798 if (fork_process) {
799 error_report("List mode is incompatible with forking");
800 exit(EXIT_FAILURE);
801 }
802 } else if ((argc - optind) != 1) {
433672b0
MA
803 error_report("Invalid number of arguments");
804 error_printf("Try `%s --help' for more information.\n", argv[0]);
85b01e09 805 exit(EXIT_FAILURE);
68b96f15
EB
806 } else if (!export_name) {
807 export_name = "";
7a5ca864
FB
808 }
809
7e1e0c11
MA
810 qemu_opts_foreach(&qemu_object_opts,
811 user_creatable_add_opts_foreach,
495bf893 812 qemu_nbd_object_print_help, &error_fatal);
0ab3b337 813
39ca463e
DL
814 if (!trace_init_backends()) {
815 exit(1);
816 }
817 trace_init_file(trace_file);
818 qemu_set_log(LOG_TRACE);
819
a721f53b
RJ
820 socket_activation = check_socket_activation();
821 if (socket_activation == 0) {
822 setup_address_and_port(&bindto, &port);
823 } else {
824 /* Using socket activation - check user didn't use -p etc. */
825 const char *err_msg = socket_activation_validate_opts(device, sockpath,
68b96f15
EB
826 bindto, port,
827 list);
a721f53b
RJ
828 if (err_msg != NULL) {
829 error_report("%s", err_msg);
830 exit(EXIT_FAILURE);
831 }
53fabd4b
PB
832
833 /* qemu-nbd can only listen on a single socket. */
834 if (socket_activation > 1) {
835 error_report("qemu-nbd does not support socket activation with %s > 1",
836 "LISTEN_FDS");
837 exit(EXIT_FAILURE);
838 }
a721f53b
RJ
839 }
840
145614a1
DB
841 if (tlscredsid) {
842 if (sockpath) {
843 error_report("TLS is only supported with IPv4/IPv6");
844 exit(EXIT_FAILURE);
845 }
846 if (device) {
847 error_report("TLS is not supported with a host device");
848 exit(EXIT_FAILURE);
849 }
b25e12da
DB
850 if (tlsauthz && list) {
851 error_report("TLS authorization is incompatible with export list");
852 exit(EXIT_FAILURE);
853 }
68b96f15 854 tlscreds = nbd_get_tls_creds(tlscredsid, list, &local_err);
145614a1 855 if (local_err) {
5217f188 856 error_reportf_err(local_err, "Failed to get TLS creds: ");
145614a1
DB
857 exit(EXIT_FAILURE);
858 }
b25e12da
DB
859 } else {
860 if (tlsauthz) {
861 error_report("--tls-authz is not permitted without --tls-creds");
862 exit(EXIT_FAILURE);
863 }
145614a1
DB
864 }
865
68b96f15
EB
866 if (list) {
867 saddr = nbd_build_socket_address(sockpath, bindto, port);
868 return qemu_nbd_client_list(saddr, tlscreds, bindto);
869 }
870
3c1fa35d
EB
871#if !HAVE_NBD_DEVICE
872 if (disconnect || device) {
873 error_report("Kernel /dev/nbdN support not available");
874 exit(EXIT_FAILURE);
875 }
876#else /* HAVE_NBD_DEVICE */
cd831bd7 877 if (disconnect) {
d0d6ff58
DB
878 int nbdfd = open(argv[optind], O_RDWR);
879 if (nbdfd < 0) {
85b01e09
MA
880 error_report("Cannot open %s: %s", argv[optind],
881 strerror(errno));
882 exit(EXIT_FAILURE);
fc19f8a0 883 }
d0d6ff58 884 nbd_disconnect(nbdfd);
cd831bd7 885
d0d6ff58 886 close(nbdfd);
cd831bd7
TS
887
888 printf("%s disconnected\n", argv[optind]);
889
713cc671 890 return 0;
cd831bd7 891 }
3c1fa35d 892#endif
cd831bd7 893
ffb31e1d 894 if ((device && !verbose) || fork_process) {
eb705985 895#ifndef WIN32
c1f8fdc3
PB
896 int stderr_fd[2];
897 pid_t pid;
898 int ret;
899
fc19f8a0 900 if (qemu_pipe(stderr_fd) < 0) {
85b01e09
MA
901 error_report("Error setting up communication pipe: %s",
902 strerror(errno));
903 exit(EXIT_FAILURE);
c1f8fdc3
PB
904 }
905
906 /* Now daemonize, but keep a communication channel open to
907 * print errors and exit with the proper status code.
908 */
909 pid = fork();
70d4739e 910 if (pid < 0) {
85b01e09
MA
911 error_report("Failed to fork: %s", strerror(errno));
912 exit(EXIT_FAILURE);
70d4739e 913 } else if (pid == 0) {
c1f8fdc3 914 close(stderr_fd[0]);
e6df58a5 915
0eaf453e
RP
916 /* Remember parent's stderr if we will be restoring it. */
917 if (fork_process) {
918 old_stderr = dup(STDERR_FILENO);
919 }
920
9faf31b6 921 ret = qemu_daemon(1, 0);
c1f8fdc3
PB
922
923 /* Temporarily redirect stderr to the parent's pipe... */
924 dup2(stderr_fd[1], STDERR_FILENO);
fc19f8a0 925 if (ret < 0) {
85b01e09
MA
926 error_report("Failed to daemonize: %s", strerror(errno));
927 exit(EXIT_FAILURE);
c1f8fdc3
PB
928 }
929
930 /* ... close the descriptor we inherited and go on. */
931 close(stderr_fd[1]);
932 } else {
933 bool errors = false;
934 char *buf;
935
936 /* In the parent. Print error messages from the child until
937 * it closes the pipe.
938 */
939 close(stderr_fd[1]);
940 buf = g_malloc(1024);
941 while ((ret = read(stderr_fd[0], buf, 1024)) > 0) {
942 errors = true;
943 ret = qemu_write_full(STDERR_FILENO, buf, ret);
fc19f8a0 944 if (ret < 0) {
c1f8fdc3
PB
945 exit(EXIT_FAILURE);
946 }
947 }
fc19f8a0 948 if (ret < 0) {
85b01e09
MA
949 error_report("Cannot read from daemon: %s",
950 strerror(errno));
951 exit(EXIT_FAILURE);
c1f8fdc3
PB
952 }
953
954 /* Usually the daemon should not print any message.
955 * Exit with zero status in that case.
956 */
957 exit(errors);
958 }
eb705985
DB
959#else /* WIN32 */
960 error_report("Unable to fork into background on Windows hosts");
961 exit(EXIT_FAILURE);
962#endif /* WIN32 */
c1f8fdc3
PB
963 }
964
a6ac2313
PB
965 if (device != NULL && sockpath == NULL) {
966 sockpath = g_malloc(128);
967 snprintf(sockpath, 128, SOCKET_PATH, basename(device));
cd831bd7
TS
968 }
969
e4849c1d 970 server = qio_net_listener_new();
a721f53b 971 if (socket_activation == 0) {
a721f53b 972 saddr = nbd_build_socket_address(sockpath, bindto, port);
fc8135c6 973 if (qio_net_listener_open_sync(server, saddr, 1, &local_err) < 0) {
e4849c1d 974 object_unref(OBJECT(server));
a721f53b 975 error_report_err(local_err);
e4849c1d 976 exit(EXIT_FAILURE);
a721f53b
RJ
977 }
978 } else {
e4849c1d 979 size_t i;
a721f53b 980 /* See comment in check_socket_activation above. */
e4849c1d
DB
981 for (i = 0; i < socket_activation; i++) {
982 QIOChannelSocket *sioc;
983 sioc = qio_channel_socket_new_fd(FIRST_SOCKET_ACTIVATION_FD + i,
984 &local_err);
985 if (sioc == NULL) {
986 object_unref(OBJECT(server));
5217f188
MA
987 error_reportf_err(local_err,
988 "Failed to use socket activation: ");
e4849c1d
DB
989 exit(EXIT_FAILURE);
990 }
991 qio_net_listener_add(server, sioc);
992 object_unref(OBJECT(sioc));
a721f53b
RJ
993 }
994 }
48bec07e 995
2f78e491 996 if (qemu_init_main_loop(&local_err)) {
565f65d2 997 error_report_err(local_err);
2f78e491
CN
998 exit(EXIT_FAILURE);
999 }
802ddc37 1000 bdrv_init();
b3b5299d 1001 atexit(qemu_nbd_shutdown);
802ddc37 1002
77c9aaef
DB
1003 srcpath = argv[optind];
1004 if (imageOpts) {
1005 QemuOpts *opts;
1006 if (fmt) {
1007 error_report("--image-opts and -f are mutually exclusive");
1008 exit(EXIT_FAILURE);
1009 }
1010 opts = qemu_opts_parse_noisily(&file_opts, srcpath, true);
1011 if (!opts) {
1012 qemu_opts_reset(&file_opts);
1013 exit(EXIT_FAILURE);
1014 }
1015 options = qemu_opts_to_qdict(opts, NULL);
1016 qemu_opts_reset(&file_opts);
efaa7c4e 1017 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
77c9aaef
DB
1018 } else {
1019 if (fmt) {
1020 options = qdict_new();
46f5ac20 1021 qdict_put_str(options, "driver", fmt);
77c9aaef 1022 }
efaa7c4e 1023 blk = blk_new_open(srcpath, NULL, options, flags, &local_err);
e6b63677
DB
1024 }
1025
4fbec260 1026 if (!blk) {
c29b77f9
MA
1027 error_reportf_err(local_err, "Failed to blk_new_open '%s': ",
1028 argv[optind]);
85b01e09 1029 exit(EXIT_FAILURE);
802ddc37 1030 }
4fbec260 1031 bs = blk_bs(blk);
802ddc37 1032
b57e4de0
KW
1033 if (dev_offset) {
1034 QDict *raw_opts = qdict_new();
1035 qdict_put_str(raw_opts, "driver", "raw");
1036 qdict_put_str(raw_opts, "file", bs->node_name);
1037 qdict_put_int(raw_opts, "offset", dev_offset);
1038 bs = bdrv_open(NULL, NULL, raw_opts, flags, &error_fatal);
1039 blk_remove_bs(blk);
1040 blk_insert_bs(blk, bs, &error_fatal);
1041 bdrv_unref(bs);
1042 }
1043
6effd5bf
KW
1044 blk_set_enable_write_cache(blk, !writethrough);
1045
8c116b0e
WX
1046 if (sn_opts) {
1047 ret = bdrv_snapshot_load_tmp(bs,
1048 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1049 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1050 &local_err);
1051 } else if (sn_id_or_name) {
1052 ret = bdrv_snapshot_load_tmp_by_id_or_name(bs, sn_id_or_name,
1053 &local_err);
1054 }
1055 if (ret < 0) {
c29b77f9 1056 error_reportf_err(local_err, "Failed to load snapshot: ");
85b01e09 1057 exit(EXIT_FAILURE);
8c116b0e
WX
1058 }
1059
b3838a40 1060 bs->detect_zeroes = detect_zeroes;
e424b655 1061
00917172
KW
1062 nbd_server_is_qemu_nbd(true);
1063
1064 export_opts = g_new(BlockExportOptions, 1);
1065 *export_opts = (BlockExportOptions) {
1066 .type = BLOCK_EXPORT_TYPE_NBD,
d53be9ce 1067 .id = g_strdup("qemu-nbd-export"),
b6076afc 1068 .node_name = g_strdup(bdrv_get_node_name(bs)),
00917172
KW
1069 .has_writethrough = true,
1070 .writethrough = writethrough,
30dbc81d
KW
1071 .has_writable = true,
1072 .writable = !readonly,
00917172 1073 .u.nbd = {
00917172
KW
1074 .has_name = true,
1075 .name = g_strdup(export_name),
1076 .has_description = !!export_description,
1077 .description = g_strdup(export_description),
00917172
KW
1078 .has_bitmap = !!bitmap,
1079 .bitmap = g_strdup(bitmap),
1080 },
1081 };
1082 blk_exp_add(export_opts, &error_fatal);
1083 qapi_free_BlockExportOptions(export_opts);
3b05a8e9 1084
f1ef5555 1085 if (device) {
3c1fa35d 1086#if HAVE_NBD_DEVICE
f1ef5555
PB
1087 int ret;
1088
a6ac2313 1089 ret = pthread_create(&client_thread, NULL, nbd_client_thread, device);
f1ef5555 1090 if (ret != 0) {
85b01e09
MA
1091 error_report("Failed to create client thread: %s", strerror(ret));
1092 exit(EXIT_FAILURE);
f1ef5555 1093 }
3c1fa35d 1094#endif
f1ef5555
PB
1095 } else {
1096 /* Shut up GCC warnings. */
1097 memset(&client_thread, 0, sizeof(client_thread));
1098 }
1099
d0d6ff58 1100 nbd_update_server_watch();
7a5ca864 1101
637bc5a5
HR
1102 if (pid_file_name) {
1103 qemu_write_pidfile(pid_file_name, &error_fatal);
1104 }
1105
9faf31b6
MT
1106 /* now when the initialization is (almost) complete, chdir("/")
1107 * to free any busy filesystems */
1108 if (chdir("/") < 0) {
85b01e09
MA
1109 error_report("Could not chdir to root directory: %s",
1110 strerror(errno));
1111 exit(EXIT_FAILURE);
9faf31b6
MT
1112 }
1113
ffb31e1d
HR
1114 if (fork_process) {
1115 dup2(old_stderr, STDERR_FILENO);
1116 close(old_stderr);
1117 }
1118
7860a380 1119 state = RUNNING;
3b05a8e9 1120 do {
a61c6782 1121 main_loop_wait(false);
7860a380 1122 if (state == TERMINATE) {
bc4ee65b 1123 blk_exp_close_all();
d794f7f3 1124 state = TERMINATED;
7860a380
PB
1125 }
1126 } while (state != TERMINATED);
7a5ca864 1127
26f54e9a 1128 blk_unref(blk);
b32f6c28
PB
1129 if (sockpath) {
1130 unlink(sockpath);
1131 }
7a5ca864 1132
fbf28a43 1133 qemu_opts_del(sn_opts);
8c116b0e 1134
a517e88b
PB
1135 if (device) {
1136 void *ret;
1137 pthread_join(client_thread, &ret);
1138 exit(ret != NULL);
1139 } else {
1140 exit(EXIT_SUCCESS);
1141 }
7a5ca864 1142}