]> git.proxmox.com Git - mirror_qemu.git/blame - qemu-nbd.c
iotests: define group in each iotest
[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"
cbc20bfb 28#include "sysemu/runstate.h" /* for qemu_system_killed() prototype */
b3838a40 29#include "block/block_int.h"
737e150e 30#include "block/nbd.h"
6a1751b7 31#include "qemu/main-loop.h"
0b8fa32f 32#include "qemu/module.h"
922a01a0 33#include "qemu/option.h"
537b41f5 34#include "qemu/error-report.h"
0ab3b337 35#include "qemu/config-file.h"
58369e22 36#include "qemu/bswap.h"
39ca463e 37#include "qemu/log.h"
53fabd4b 38#include "qemu/systemd.h"
8c116b0e 39#include "block/snapshot.h"
452fcdbc 40#include "qapi/qmp/qdict.h"
d49b6836 41#include "qapi/qmp/qstring.h"
0ab3b337 42#include "qom/object_interfaces.h"
d0d6ff58 43#include "io/channel-socket.h"
e4849c1d 44#include "io/net-listener.h"
c2297088 45#include "crypto/init.h"
39ca463e 46#include "trace/control.h"
be377133 47#include "qemu-version.h"
7a5ca864 48
3c1fa35d
EB
49#ifdef __linux__
50#define HAVE_NBD_DEVICE 1
51#else
52#define HAVE_NBD_DEVICE 0
53#endif
54
713cc671 55#define SOCKET_PATH "/var/lock/qemu-nbd-%s"
fa8b7ce2
DB
56#define QEMU_NBD_OPT_CACHE 256
57#define QEMU_NBD_OPT_AIO 257
58#define QEMU_NBD_OPT_DISCARD 258
59#define QEMU_NBD_OPT_DETECT_ZEROES 259
60#define QEMU_NBD_OPT_OBJECT 260
61#define QEMU_NBD_OPT_TLSCREDS 261
62#define QEMU_NBD_OPT_IMAGE_OPTS 262
ffb31e1d 63#define QEMU_NBD_OPT_FORK 263
b25e12da 64#define QEMU_NBD_OPT_TLSAUTHZ 264
637bc5a5 65#define QEMU_NBD_OPT_PID_FILE 265
7a5ca864 66
bd31c214
EB
67#define MBR_SIZE 512
68
b1d8e52e 69static int verbose;
a517e88b 70static char *srcpath;
bd269ebc 71static SocketAddress *saddr;
7860a380 72static int persistent = 0;
d794f7f3 73static enum { RUNNING, TERMINATE, TERMINATED } state;
a61c6782
PB
74static int shared = 1;
75static int nb_fds;
e4849c1d 76static QIONetListener *server;
145614a1 77static QCryptoTLSCreds *tlscreds;
b25e12da 78static const char *tlsauthz;
7a5ca864
FB
79
80static void usage(const char *name)
81{
b033cd86 82 (printf) (
7a5ca864 83"Usage: %s [OPTIONS] FILE\n"
68b96f15
EB
84" or: %s -L [OPTIONS]\n"
85"QEMU Disk Network Block Device Utility\n"
7a5ca864 86"\n"
713cc671
PL
87" -h, --help display this help and exit\n"
88" -V, --version output version information and exit\n"
b033cd86
PB
89"\n"
90"Connection properties:\n"
713cc671
PL
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"
f5cd0bb5
VSO
98" -x, --export-name=NAME expose export by name (default is empty string)\n"
99" -D, --description=TEXT export a human-readable description\n"
7a5ca864 100"\n"
b033cd86 101"Exposing part of the image:\n"
713cc671 102" -o, --offset=OFFSET offset into the image\n"
dbc7b014 103" -A, --allocation-depth expose the allocation depth\n"
636192c4 104" -B, --bitmap=NAME expose a persistent dirty bitmap\n"
b033cd86 105"\n"
0ab3b337 106"General purpose options:\n"
68b96f15 107" -L, --list list exports available from another NBD server\n"
0ab3b337
DB
108" --object type,id=ID,... define an object such as 'secret' for providing\n"
109" passwords and/or encryption keys\n"
f7812df7 110" --tls-creds=ID use id of an earlier --object to provide TLS\n"
b25e12da
DB
111" --tls-authz=ID use id of an earlier --object to provide\n"
112" authorization\n"
39ca463e
DL
113" -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
114" specify tracing options\n"
ffb31e1d
HR
115" --fork fork off the server process and exit the parent\n"
116" once the server is running\n"
637bc5a5 117" --pid-file=PATH store the server's process ID in the given file\n"
3c1fa35d
EB
118#if HAVE_NBD_DEVICE
119"\n"
b033cd86 120"Kernel NBD client support:\n"
713cc671
PL
121" -c, --connect=DEV connect FILE to the local NBD device DEV\n"
122" -d, --disconnect disconnect the specified device\n"
b033cd86
PB
123#endif
124"\n"
125"Block device options:\n"
713cc671
PL
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"
8c116b0e 131" -l, --load-snapshot=SNAPSHOT_PARAM\n"
713cc671
PL
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"
135" '[ID_OR_NAME]'\n"
136" -n, --nocache disable host cache\n"
137" --cache=MODE set cache mode (none, writeback, ...)\n"
7680274d 138" --aio=MODE set AIO mode (native, io_uring or threads)\n"
b3838a40 139" --discard=MODE set discard mode (ignore, unmap)\n"
6883de6c 140" --detect-zeroes=MODE set detect-zeroes mode (off, on, unmap)\n"
77c9aaef 141" --image-opts treat FILE as a full set of image options\n"
b033cd86 142"\n"
f5048cb7 143QEMU_HELP_BOTTOM "\n"
68b96f15 144 , name, name, NBD_DEFAULT_PORT, "DEVICE");
7a5ca864
FB
145}
146
147static void version(const char *name)
148{
149 printf(
7e563bfb 150"%s " QEMU_FULL_VERSION "\n"
7a5ca864
FB
151"Written by Anthony Liguori.\n"
152"\n"
be377133 153QEMU_COPYRIGHT "\n"
7a5ca864
FB
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"
315bc7aa 156 , name);
7a5ca864
FB
157}
158
029a88c9 159#ifdef CONFIG_POSIX
cbc20bfb
SH
160/*
161 * The client thread uses SIGTERM to interrupt the server. A signal
162 * handler ensures that "qemu-nbd -v -c" exits with a nice status code.
163 */
164void qemu_system_killed(int signum, pid_t pid)
bb345110 165{
d73415a3 166 qatomic_cmpxchg(&state, RUNNING, TERMINATE);
a61c6782 167 qemu_notify_event();
bb345110 168}
029a88c9 169#endif /* CONFIG_POSIX */
537b41f5 170
68b96f15
EB
171static int qemu_nbd_client_list(SocketAddress *saddr, QCryptoTLSCreds *tls,
172 const char *hostname)
173{
174 int ret = EXIT_FAILURE;
175 int rc;
176 Error *err = NULL;
177 QIOChannelSocket *sioc;
178 NBDExportInfo *list;
179 int i, j;
180
181 sioc = qio_channel_socket_new();
182 if (qio_channel_socket_connect_sync(sioc, saddr, &err) < 0) {
183 error_report_err(err);
992809bf 184 goto out;
68b96f15
EB
185 }
186 rc = nbd_receive_export_list(QIO_CHANNEL(sioc), tls, hostname, &list,
187 &err);
188 if (rc < 0) {
189 if (err) {
190 error_report_err(err);
191 }
192 goto out;
193 }
194 printf("exports available: %d\n", rc);
195 for (i = 0; i < rc; i++) {
196 printf(" export: '%s'\n", list[i].name);
197 if (list[i].description && *list[i].description) {
198 printf(" description: %s\n", list[i].description);
199 }
200 if (list[i].flags & NBD_FLAG_HAS_FLAGS) {
c4e2aff8
HR
201 static const char *const flag_names[] = {
202 [NBD_FLAG_READ_ONLY_BIT] = "readonly",
203 [NBD_FLAG_SEND_FLUSH_BIT] = "flush",
204 [NBD_FLAG_SEND_FUA_BIT] = "fua",
205 [NBD_FLAG_ROTATIONAL_BIT] = "rotational",
206 [NBD_FLAG_SEND_TRIM_BIT] = "trim",
207 [NBD_FLAG_SEND_WRITE_ZEROES_BIT] = "zeroes",
208 [NBD_FLAG_SEND_DF_BIT] = "df",
209 [NBD_FLAG_CAN_MULTI_CONN_BIT] = "multi",
210 [NBD_FLAG_SEND_RESIZE_BIT] = "resize",
211 [NBD_FLAG_SEND_CACHE_BIT] = "cache",
0a479545 212 [NBD_FLAG_SEND_FAST_ZERO_BIT] = "fast-zero",
c4e2aff8
HR
213 };
214
68b96f15
EB
215 printf(" size: %" PRIu64 "\n", list[i].size);
216 printf(" flags: 0x%x (", list[i].flags);
c4e2aff8
HR
217 for (size_t bit = 0; bit < ARRAY_SIZE(flag_names); bit++) {
218 if (flag_names[bit] && (list[i].flags & (1 << bit))) {
219 printf(" %s", flag_names[bit]);
220 }
68b96f15
EB
221 }
222 printf(" )\n");
223 }
224 if (list[i].min_block) {
225 printf(" min block: %u\n", list[i].min_block);
226 printf(" opt block: %u\n", list[i].opt_block);
227 printf(" max block: %u\n", list[i].max_block);
228 }
229 if (list[i].n_contexts) {
230 printf(" available meta contexts: %d\n", list[i].n_contexts);
231 for (j = 0; j < list[i].n_contexts; j++) {
232 printf(" %s\n", list[i].contexts[j]);
233 }
234 }
235 }
236 nbd_free_export_list(list, rc);
237
238 ret = EXIT_SUCCESS;
239 out:
240 object_unref(OBJECT(sioc));
241 return ret;
242}
243
244
3c1fa35d 245#if HAVE_NBD_DEVICE
a517e88b 246static void *show_parts(void *arg)
cd831bd7 247{
a6ac2313 248 char *device = arg;
a517e88b
PB
249 int nbd;
250
251 /* linux just needs an open() to trigger
252 * the partition table update
253 * but remember to load the module with max_part != 0 :
254 * modprobe nbd max_part=63
255 */
256 nbd = open(device, O_RDWR);
fc19f8a0 257 if (nbd >= 0) {
a517e88b
PB
258 close(nbd);
259 }
260 return NULL;
261}
cd831bd7 262
a517e88b
PB
263static void *nbd_client_thread(void *arg)
264{
a6ac2313 265 char *device = arg;
6dc1667d 266 NBDExportInfo info = { .request_sizes = false, .name = g_strdup("") };
d0d6ff58 267 QIOChannelSocket *sioc;
af74b550
AC
268 int fd = -1;
269 int ret = EXIT_FAILURE;
a517e88b 270 pthread_t show_parts_thread;
1ce52846 271 Error *local_error = NULL;
a517e88b 272
d0d6ff58
DB
273 sioc = qio_channel_socket_new();
274 if (qio_channel_socket_connect_sync(sioc,
275 saddr,
276 &local_error) < 0) {
48bec07e 277 error_report_err(local_error);
dc10e8b3
SH
278 goto out;
279 }
a517e88b 280
af74b550
AC
281 if (nbd_receive_negotiate(NULL, QIO_CHANNEL(sioc),
282 NULL, NULL, NULL, &info, &local_error) < 0) {
1ce52846 283 if (local_error) {
78288671 284 error_report_err(local_error);
1ce52846 285 }
af74b550 286 goto out;
a517e88b
PB
287 }
288
a6ac2313 289 fd = open(device, O_RDWR);
fc19f8a0 290 if (fd < 0) {
a6ac2313 291 /* Linux-only, we can use %m in printf. */
b9884681 292 error_report("Failed to open %s: %m", device);
af74b550 293 goto out;
a6ac2313
PB
294 }
295
af74b550 296 if (nbd_init(fd, sioc, &info, &local_error) < 0) {
be41c100 297 error_report_err(local_error);
af74b550 298 goto out;
a517e88b
PB
299 }
300
301 /* update partition table */
a6ac2313 302 pthread_create(&show_parts_thread, NULL, show_parts, device);
a517e88b 303
c1f8fdc3
PB
304 if (verbose) {
305 fprintf(stderr, "NBD device %s is now connected to %s\n",
306 device, srcpath);
307 } else {
308 /* Close stderr so that the qemu-nbd process exits. */
309 dup2(STDOUT_FILENO, STDERR_FILENO);
310 }
a517e88b 311
af74b550
AC
312 if (nbd_client(fd) < 0) {
313 goto out;
cd831bd7 314 }
a517e88b 315
af74b550
AC
316 ret = EXIT_SUCCESS;
317
318 out:
319 if (fd >= 0) {
320 close(fd);
321 }
d0d6ff58 322 object_unref(OBJECT(sioc));
6dc1667d 323 g_free(info.name);
a517e88b 324 kill(getpid(), SIGTERM);
af74b550 325 return (void *) (intptr_t) ret;
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;
dbc7b014 522 const char *sopt = "hVb:o:p:rsnc:dvk:e:f:tl:x:T:D:AB: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' },
dbc7b014 531 { "allocation-depth", no_argument, NULL, 'A' },
636192c4 532 { "bitmap", required_argument, NULL, 'B' },
aa6e546c
DB
533 { "connect", required_argument, NULL, 'c' },
534 { "disconnect", no_argument, NULL, 'd' },
68b96f15 535 { "list", no_argument, NULL, 'L' },
aa6e546c
DB
536 { "snapshot", no_argument, NULL, 's' },
537 { "load-snapshot", required_argument, NULL, 'l' },
538 { "nocache", no_argument, NULL, 'n' },
539 { "cache", required_argument, NULL, QEMU_NBD_OPT_CACHE },
540 { "aio", required_argument, NULL, QEMU_NBD_OPT_AIO },
541 { "discard", required_argument, NULL, QEMU_NBD_OPT_DISCARD },
542 { "detect-zeroes", required_argument, NULL,
543 QEMU_NBD_OPT_DETECT_ZEROES },
544 { "shared", required_argument, NULL, 'e' },
545 { "format", required_argument, NULL, 'f' },
546 { "persistent", no_argument, NULL, 't' },
547 { "verbose", no_argument, NULL, 'v' },
548 { "object", required_argument, NULL, QEMU_NBD_OPT_OBJECT },
549 { "export-name", required_argument, NULL, 'x' },
b1a75b33 550 { "description", required_argument, NULL, 'D' },
aa6e546c 551 { "tls-creds", required_argument, NULL, QEMU_NBD_OPT_TLSCREDS },
b25e12da 552 { "tls-authz", required_argument, NULL, QEMU_NBD_OPT_TLSAUTHZ },
aa6e546c 553 { "image-opts", no_argument, NULL, QEMU_NBD_OPT_IMAGE_OPTS },
39ca463e 554 { "trace", required_argument, NULL, 'T' },
ffb31e1d 555 { "fork", no_argument, NULL, QEMU_NBD_OPT_FORK },
637bc5a5 556 { "pid-file", required_argument, NULL, QEMU_NBD_OPT_PID_FILE },
660f11be 557 { NULL, 0, NULL, 0 }
7a5ca864
FB
558 };
559 int ch;
560 int opt_ind = 0;
f5edb014 561 int flags = BDRV_O_RDWR;
4fbec260 562 int ret = 0;
39a5235c 563 bool seen_cache = false;
ded9d2d5 564 bool seen_discard = false;
39a5235c 565 bool seen_aio = false;
a517e88b 566 pthread_t client_thread;
e6b63677 567 const char *fmt = NULL;
34b5d2c6 568 Error *local_err = NULL;
b3838a40 569 BlockdevDetectZeroesOptions detect_zeroes = BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
4fbec260 570 QDict *options = NULL;
68b96f15 571 const char *export_name = NULL; /* defaults to "" later for server mode */
b1a75b33 572 const char *export_description = NULL;
cbad81ce 573 strList *bitmaps = NULL;
dbc7b014 574 bool alloc_depth = false;
145614a1 575 const char *tlscredsid = NULL;
77c9aaef 576 bool imageOpts = false;
6effd5bf 577 bool writethrough = true;
ffb31e1d 578 bool fork_process = false;
68b96f15 579 bool list = false;
ffb31e1d 580 int old_stderr = -1;
a721f53b 581 unsigned socket_activation;
637bc5a5 582 const char *pid_file_name = NULL;
00917172 583 BlockExportOptions *export_opts;
7a5ca864 584
029a88c9 585#ifdef CONFIG_POSIX
cbc20bfb
SH
586 os_setup_early_signal_handling();
587 os_setup_signal_handling();
041e32b8
HR
588#endif
589
98c5d2e7 590 socket_init();
f5852efa 591 error_init(argv[0]);
fe4db84d 592 module_call_init(MODULE_INIT_TRACE);
e8f2d272 593 qcrypto_init(&error_fatal);
c2297088 594
0ab3b337
DB
595 module_call_init(MODULE_INIT_QOM);
596 qemu_add_opts(&qemu_object_opts);
39ca463e 597 qemu_add_opts(&qemu_trace_opts);
10f5bff6 598 qemu_init_exec_dir(argv[0]);
bb345110 599
7a5ca864
FB
600 while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
601 switch (ch) {
602 case 's':
2f726488
TS
603 flags |= BDRV_O_SNAPSHOT;
604 break;
605 case 'n':
39a5235c
PB
606 optarg = (char *) "none";
607 /* fallthrough */
608 case QEMU_NBD_OPT_CACHE:
609 if (seen_cache) {
85b01e09
MA
610 error_report("-n and --cache can only be specified once");
611 exit(EXIT_FAILURE);
39a5235c
PB
612 }
613 seen_cache = true;
6effd5bf 614 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) == -1) {
85b01e09
MA
615 error_report("Invalid cache mode `%s'", optarg);
616 exit(EXIT_FAILURE);
39a5235c 617 }
7a5ca864 618 break;
39a5235c
PB
619 case QEMU_NBD_OPT_AIO:
620 if (seen_aio) {
85b01e09
MA
621 error_report("--aio can only be specified once");
622 exit(EXIT_FAILURE);
39a5235c
PB
623 }
624 seen_aio = true;
7680274d
AM
625 if (bdrv_parse_aio(optarg, &flags) < 0) {
626 error_report("Invalid aio mode '%s'", optarg);
627 exit(EXIT_FAILURE);
39a5235c
PB
628 }
629 break;
ded9d2d5
PB
630 case QEMU_NBD_OPT_DISCARD:
631 if (seen_discard) {
85b01e09
MA
632 error_report("--discard can only be specified once");
633 exit(EXIT_FAILURE);
ded9d2d5
PB
634 }
635 seen_discard = true;
636 if (bdrv_parse_discard_flags(optarg, &flags) == -1) {
85b01e09
MA
637 error_report("Invalid discard mode `%s'", optarg);
638 exit(EXIT_FAILURE);
ded9d2d5
PB
639 }
640 break;
b3838a40
PL
641 case QEMU_NBD_OPT_DETECT_ZEROES:
642 detect_zeroes =
f7abe0ec 643 qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
b3838a40 644 optarg,
b3838a40
PL
645 BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
646 &local_err);
647 if (local_err) {
c29b77f9
MA
648 error_reportf_err(local_err,
649 "Failed to parse detect_zeroes mode: ");
85b01e09 650 exit(EXIT_FAILURE);
b3838a40
PL
651 }
652 if (detect_zeroes == BLOCKDEV_DETECT_ZEROES_OPTIONS_UNMAP &&
653 !(flags & BDRV_O_UNMAP)) {
85b01e09
MA
654 error_report("setting detect-zeroes to unmap is not allowed "
655 "without setting discard operation to unmap");
656 exit(EXIT_FAILURE);
b3838a40
PL
657 }
658 break;
7a5ca864
FB
659 case 'b':
660 bindto = optarg;
661 break;
662 case 'p':
48bec07e 663 port = optarg;
7a5ca864
FB
664 break;
665 case 'o':
43b51011
EB
666 if (qemu_strtou64(optarg, NULL, 0, &dev_offset) < 0) {
667 error_report("Invalid offset '%s'", optarg);
85b01e09 668 exit(EXIT_FAILURE);
7a5ca864 669 }
7a5ca864 670 break;
8c116b0e
WX
671 case 'l':
672 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
70b94331
MA
673 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
674 optarg, false);
8c116b0e 675 if (!sn_opts) {
85b01e09
MA
676 error_report("Failed in parsing snapshot param `%s'",
677 optarg);
678 exit(EXIT_FAILURE);
8c116b0e
WX
679 }
680 } else {
681 sn_id_or_name = optarg;
682 }
683 /* fall through */
7a5ca864 684 case 'r':
dbb38caa 685 readonly = true;
07108b29 686 flags &= ~BDRV_O_RDWR;
7a5ca864 687 break;
dbc7b014
EB
688 case 'A':
689 alloc_depth = true;
690 break;
636192c4 691 case 'B':
cbad81ce 692 QAPI_LIST_PREPEND(bitmaps, g_strdup(optarg));
636192c4 693 break;
cd831bd7 694 case 'k':
b32f6c28 695 sockpath = optarg;
713cc671 696 if (sockpath[0] != '/') {
9af9e0fe 697 error_report("socket path must be absolute");
85b01e09 698 exit(EXIT_FAILURE);
713cc671 699 }
cd831bd7
TS
700 break;
701 case 'd':
702 disconnect = true;
703 break;
704 case 'c':
705 device = optarg;
706 break;
3b05a8e9 707 case 'e':
43b51011
EB
708 if (qemu_strtoi(optarg, NULL, 0, &shared) < 0 ||
709 shared < 1) {
85b01e09
MA
710 error_report("Invalid shared device number '%s'", optarg);
711 exit(EXIT_FAILURE);
3b05a8e9 712 }
3b05a8e9 713 break;
e6b63677
DB
714 case 'f':
715 fmt = optarg;
716 break;
713cc671
PL
717 case 't':
718 persistent = 1;
719 break;
3d4b2f9c
DB
720 case 'x':
721 export_name = optarg;
93676c88
EB
722 if (strlen(export_name) > NBD_MAX_STRING_SIZE) {
723 error_report("export name '%s' too long", export_name);
724 exit(EXIT_FAILURE);
725 }
3d4b2f9c 726 break;
b1a75b33
EB
727 case 'D':
728 export_description = optarg;
93676c88
EB
729 if (strlen(export_description) > NBD_MAX_STRING_SIZE) {
730 error_report("export description '%s' too long",
731 export_description);
732 exit(EXIT_FAILURE);
733 }
b1a75b33 734 break;
7a5ca864
FB
735 case 'v':
736 verbose = 1;
737 break;
738 case 'V':
739 version(argv[0]);
740 exit(0);
741 break;
742 case 'h':
743 usage(argv[0]);
744 exit(0);
745 break;
746 case '?':
85b01e09
MA
747 error_report("Try `%s --help' for more information.", argv[0]);
748 exit(EXIT_FAILURE);
0ab3b337
DB
749 case QEMU_NBD_OPT_OBJECT: {
750 QemuOpts *opts;
751 opts = qemu_opts_parse_noisily(&qemu_object_opts,
752 optarg, true);
753 if (!opts) {
754 exit(EXIT_FAILURE);
755 }
756 } break;
145614a1
DB
757 case QEMU_NBD_OPT_TLSCREDS:
758 tlscredsid = optarg;
759 break;
77c9aaef
DB
760 case QEMU_NBD_OPT_IMAGE_OPTS:
761 imageOpts = true;
762 break;
39ca463e 763 case 'T':
92eecfff 764 trace_opt_parse(optarg);
39ca463e 765 break;
b25e12da
DB
766 case QEMU_NBD_OPT_TLSAUTHZ:
767 tlsauthz = optarg;
768 break;
ffb31e1d
HR
769 case QEMU_NBD_OPT_FORK:
770 fork_process = true;
771 break;
68b96f15
EB
772 case 'L':
773 list = true;
774 break;
637bc5a5
HR
775 case QEMU_NBD_OPT_PID_FILE:
776 pid_file_name = optarg;
777 break;
7a5ca864
FB
778 }
779 }
780
68b96f15
EB
781 if (list) {
782 if (argc != optind) {
783 error_report("List mode is incompatible with a file name");
784 exit(EXIT_FAILURE);
785 }
0bc16997 786 if (export_name || export_description || dev_offset ||
cbad81ce 787 device || disconnect || fmt || sn_id_or_name || bitmaps ||
dbc7b014 788 alloc_depth || seen_aio || seen_discard || seen_cache) {
68b96f15
EB
789 error_report("List mode is incompatible with per-device settings");
790 exit(EXIT_FAILURE);
791 }
792 if (fork_process) {
793 error_report("List mode is incompatible with forking");
794 exit(EXIT_FAILURE);
795 }
796 } else if ((argc - optind) != 1) {
433672b0
MA
797 error_report("Invalid number of arguments");
798 error_printf("Try `%s --help' for more information.\n", argv[0]);
85b01e09 799 exit(EXIT_FAILURE);
68b96f15
EB
800 } else if (!export_name) {
801 export_name = "";
7a5ca864
FB
802 }
803
7e1e0c11
MA
804 qemu_opts_foreach(&qemu_object_opts,
805 user_creatable_add_opts_foreach,
495bf893 806 qemu_nbd_object_print_help, &error_fatal);
0ab3b337 807
39ca463e
DL
808 if (!trace_init_backends()) {
809 exit(1);
810 }
92eecfff 811 trace_init_file();
39ca463e
DL
812 qemu_set_log(LOG_TRACE);
813
a721f53b
RJ
814 socket_activation = check_socket_activation();
815 if (socket_activation == 0) {
816 setup_address_and_port(&bindto, &port);
817 } else {
818 /* Using socket activation - check user didn't use -p etc. */
819 const char *err_msg = socket_activation_validate_opts(device, sockpath,
68b96f15
EB
820 bindto, port,
821 list);
a721f53b
RJ
822 if (err_msg != NULL) {
823 error_report("%s", err_msg);
824 exit(EXIT_FAILURE);
825 }
53fabd4b
PB
826
827 /* qemu-nbd can only listen on a single socket. */
828 if (socket_activation > 1) {
829 error_report("qemu-nbd does not support socket activation with %s > 1",
830 "LISTEN_FDS");
831 exit(EXIT_FAILURE);
832 }
a721f53b
RJ
833 }
834
145614a1
DB
835 if (tlscredsid) {
836 if (sockpath) {
837 error_report("TLS is only supported with IPv4/IPv6");
838 exit(EXIT_FAILURE);
839 }
840 if (device) {
841 error_report("TLS is not supported with a host device");
842 exit(EXIT_FAILURE);
843 }
b25e12da
DB
844 if (tlsauthz && list) {
845 error_report("TLS authorization is incompatible with export list");
846 exit(EXIT_FAILURE);
847 }
68b96f15 848 tlscreds = nbd_get_tls_creds(tlscredsid, list, &local_err);
145614a1 849 if (local_err) {
5217f188 850 error_reportf_err(local_err, "Failed to get TLS creds: ");
145614a1
DB
851 exit(EXIT_FAILURE);
852 }
b25e12da
DB
853 } else {
854 if (tlsauthz) {
855 error_report("--tls-authz is not permitted without --tls-creds");
856 exit(EXIT_FAILURE);
857 }
145614a1
DB
858 }
859
68b96f15
EB
860 if (list) {
861 saddr = nbd_build_socket_address(sockpath, bindto, port);
862 return qemu_nbd_client_list(saddr, tlscreds, bindto);
863 }
864
3c1fa35d
EB
865#if !HAVE_NBD_DEVICE
866 if (disconnect || device) {
867 error_report("Kernel /dev/nbdN support not available");
868 exit(EXIT_FAILURE);
869 }
870#else /* HAVE_NBD_DEVICE */
cd831bd7 871 if (disconnect) {
d0d6ff58
DB
872 int nbdfd = open(argv[optind], O_RDWR);
873 if (nbdfd < 0) {
85b01e09
MA
874 error_report("Cannot open %s: %s", argv[optind],
875 strerror(errno));
876 exit(EXIT_FAILURE);
fc19f8a0 877 }
d0d6ff58 878 nbd_disconnect(nbdfd);
cd831bd7 879
d0d6ff58 880 close(nbdfd);
cd831bd7
TS
881
882 printf("%s disconnected\n", argv[optind]);
883
713cc671 884 return 0;
cd831bd7 885 }
3c1fa35d 886#endif
cd831bd7 887
ffb31e1d 888 if ((device && !verbose) || fork_process) {
eb705985 889#ifndef WIN32
c1f8fdc3
PB
890 int stderr_fd[2];
891 pid_t pid;
892 int ret;
893
fc19f8a0 894 if (qemu_pipe(stderr_fd) < 0) {
85b01e09
MA
895 error_report("Error setting up communication pipe: %s",
896 strerror(errno));
897 exit(EXIT_FAILURE);
c1f8fdc3
PB
898 }
899
900 /* Now daemonize, but keep a communication channel open to
901 * print errors and exit with the proper status code.
902 */
903 pid = fork();
70d4739e 904 if (pid < 0) {
85b01e09
MA
905 error_report("Failed to fork: %s", strerror(errno));
906 exit(EXIT_FAILURE);
70d4739e 907 } else if (pid == 0) {
c1f8fdc3 908 close(stderr_fd[0]);
e6df58a5 909
0eaf453e
RP
910 /* Remember parent's stderr if we will be restoring it. */
911 if (fork_process) {
912 old_stderr = dup(STDERR_FILENO);
913 }
914
9faf31b6 915 ret = qemu_daemon(1, 0);
c1f8fdc3
PB
916
917 /* Temporarily redirect stderr to the parent's pipe... */
918 dup2(stderr_fd[1], STDERR_FILENO);
fc19f8a0 919 if (ret < 0) {
85b01e09
MA
920 error_report("Failed to daemonize: %s", strerror(errno));
921 exit(EXIT_FAILURE);
c1f8fdc3
PB
922 }
923
924 /* ... close the descriptor we inherited and go on. */
925 close(stderr_fd[1]);
926 } else {
927 bool errors = false;
928 char *buf;
929
930 /* In the parent. Print error messages from the child until
931 * it closes the pipe.
932 */
933 close(stderr_fd[1]);
934 buf = g_malloc(1024);
935 while ((ret = read(stderr_fd[0], buf, 1024)) > 0) {
936 errors = true;
937 ret = qemu_write_full(STDERR_FILENO, buf, ret);
fc19f8a0 938 if (ret < 0) {
c1f8fdc3
PB
939 exit(EXIT_FAILURE);
940 }
941 }
fc19f8a0 942 if (ret < 0) {
85b01e09
MA
943 error_report("Cannot read from daemon: %s",
944 strerror(errno));
945 exit(EXIT_FAILURE);
c1f8fdc3
PB
946 }
947
948 /* Usually the daemon should not print any message.
949 * Exit with zero status in that case.
950 */
951 exit(errors);
952 }
eb705985
DB
953#else /* WIN32 */
954 error_report("Unable to fork into background on Windows hosts");
955 exit(EXIT_FAILURE);
956#endif /* WIN32 */
c1f8fdc3
PB
957 }
958
a6ac2313
PB
959 if (device != NULL && sockpath == NULL) {
960 sockpath = g_malloc(128);
961 snprintf(sockpath, 128, SOCKET_PATH, basename(device));
cd831bd7
TS
962 }
963
e4849c1d 964 server = qio_net_listener_new();
a721f53b 965 if (socket_activation == 0) {
a721f53b 966 saddr = nbd_build_socket_address(sockpath, bindto, port);
fc8135c6 967 if (qio_net_listener_open_sync(server, saddr, 1, &local_err) < 0) {
e4849c1d 968 object_unref(OBJECT(server));
a721f53b 969 error_report_err(local_err);
e4849c1d 970 exit(EXIT_FAILURE);
a721f53b
RJ
971 }
972 } else {
e4849c1d 973 size_t i;
a721f53b 974 /* See comment in check_socket_activation above. */
e4849c1d
DB
975 for (i = 0; i < socket_activation; i++) {
976 QIOChannelSocket *sioc;
977 sioc = qio_channel_socket_new_fd(FIRST_SOCKET_ACTIVATION_FD + i,
978 &local_err);
979 if (sioc == NULL) {
980 object_unref(OBJECT(server));
5217f188
MA
981 error_reportf_err(local_err,
982 "Failed to use socket activation: ");
e4849c1d
DB
983 exit(EXIT_FAILURE);
984 }
985 qio_net_listener_add(server, sioc);
986 object_unref(OBJECT(sioc));
a721f53b
RJ
987 }
988 }
48bec07e 989
2f78e491 990 if (qemu_init_main_loop(&local_err)) {
565f65d2 991 error_report_err(local_err);
2f78e491
CN
992 exit(EXIT_FAILURE);
993 }
802ddc37 994 bdrv_init();
b3b5299d 995 atexit(qemu_nbd_shutdown);
802ddc37 996
77c9aaef
DB
997 srcpath = argv[optind];
998 if (imageOpts) {
999 QemuOpts *opts;
1000 if (fmt) {
1001 error_report("--image-opts and -f are mutually exclusive");
1002 exit(EXIT_FAILURE);
1003 }
1004 opts = qemu_opts_parse_noisily(&file_opts, srcpath, true);
1005 if (!opts) {
1006 qemu_opts_reset(&file_opts);
1007 exit(EXIT_FAILURE);
1008 }
1009 options = qemu_opts_to_qdict(opts, NULL);
1010 qemu_opts_reset(&file_opts);
efaa7c4e 1011 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
77c9aaef
DB
1012 } else {
1013 if (fmt) {
1014 options = qdict_new();
46f5ac20 1015 qdict_put_str(options, "driver", fmt);
77c9aaef 1016 }
efaa7c4e 1017 blk = blk_new_open(srcpath, NULL, options, flags, &local_err);
e6b63677
DB
1018 }
1019
4fbec260 1020 if (!blk) {
c29b77f9
MA
1021 error_reportf_err(local_err, "Failed to blk_new_open '%s': ",
1022 argv[optind]);
85b01e09 1023 exit(EXIT_FAILURE);
802ddc37 1024 }
4fbec260 1025 bs = blk_bs(blk);
802ddc37 1026
b57e4de0
KW
1027 if (dev_offset) {
1028 QDict *raw_opts = qdict_new();
1029 qdict_put_str(raw_opts, "driver", "raw");
1030 qdict_put_str(raw_opts, "file", bs->node_name);
1031 qdict_put_int(raw_opts, "offset", dev_offset);
1032 bs = bdrv_open(NULL, NULL, raw_opts, flags, &error_fatal);
1033 blk_remove_bs(blk);
1034 blk_insert_bs(blk, bs, &error_fatal);
1035 bdrv_unref(bs);
1036 }
1037
6effd5bf
KW
1038 blk_set_enable_write_cache(blk, !writethrough);
1039
8c116b0e
WX
1040 if (sn_opts) {
1041 ret = bdrv_snapshot_load_tmp(bs,
1042 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1043 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1044 &local_err);
1045 } else if (sn_id_or_name) {
1046 ret = bdrv_snapshot_load_tmp_by_id_or_name(bs, sn_id_or_name,
1047 &local_err);
1048 }
1049 if (ret < 0) {
c29b77f9 1050 error_reportf_err(local_err, "Failed to load snapshot: ");
85b01e09 1051 exit(EXIT_FAILURE);
8c116b0e
WX
1052 }
1053
b3838a40 1054 bs->detect_zeroes = detect_zeroes;
e424b655 1055
00917172
KW
1056 nbd_server_is_qemu_nbd(true);
1057
1058 export_opts = g_new(BlockExportOptions, 1);
1059 *export_opts = (BlockExportOptions) {
1060 .type = BLOCK_EXPORT_TYPE_NBD,
d53be9ce 1061 .id = g_strdup("qemu-nbd-export"),
b6076afc 1062 .node_name = g_strdup(bdrv_get_node_name(bs)),
00917172
KW
1063 .has_writethrough = true,
1064 .writethrough = writethrough,
30dbc81d
KW
1065 .has_writable = true,
1066 .writable = !readonly,
00917172 1067 .u.nbd = {
cbad81ce
EB
1068 .has_name = true,
1069 .name = g_strdup(export_name),
1070 .has_description = !!export_description,
1071 .description = g_strdup(export_description),
1072 .has_bitmaps = !!bitmaps,
1073 .bitmaps = bitmaps,
dbc7b014
EB
1074 .has_allocation_depth = alloc_depth,
1075 .allocation_depth = alloc_depth,
00917172
KW
1076 },
1077 };
1078 blk_exp_add(export_opts, &error_fatal);
1079 qapi_free_BlockExportOptions(export_opts);
3b05a8e9 1080
f1ef5555 1081 if (device) {
3c1fa35d 1082#if HAVE_NBD_DEVICE
f1ef5555
PB
1083 int ret;
1084
a6ac2313 1085 ret = pthread_create(&client_thread, NULL, nbd_client_thread, device);
f1ef5555 1086 if (ret != 0) {
85b01e09
MA
1087 error_report("Failed to create client thread: %s", strerror(ret));
1088 exit(EXIT_FAILURE);
f1ef5555 1089 }
3c1fa35d 1090#endif
f1ef5555
PB
1091 } else {
1092 /* Shut up GCC warnings. */
1093 memset(&client_thread, 0, sizeof(client_thread));
1094 }
1095
d0d6ff58 1096 nbd_update_server_watch();
7a5ca864 1097
637bc5a5
HR
1098 if (pid_file_name) {
1099 qemu_write_pidfile(pid_file_name, &error_fatal);
1100 }
1101
9faf31b6
MT
1102 /* now when the initialization is (almost) complete, chdir("/")
1103 * to free any busy filesystems */
1104 if (chdir("/") < 0) {
85b01e09
MA
1105 error_report("Could not chdir to root directory: %s",
1106 strerror(errno));
1107 exit(EXIT_FAILURE);
9faf31b6
MT
1108 }
1109
ffb31e1d
HR
1110 if (fork_process) {
1111 dup2(old_stderr, STDERR_FILENO);
1112 close(old_stderr);
1113 }
1114
7860a380 1115 state = RUNNING;
3b05a8e9 1116 do {
a61c6782 1117 main_loop_wait(false);
7860a380 1118 if (state == TERMINATE) {
bc4ee65b 1119 blk_exp_close_all();
d794f7f3 1120 state = TERMINATED;
7860a380
PB
1121 }
1122 } while (state != TERMINATED);
7a5ca864 1123
26f54e9a 1124 blk_unref(blk);
b32f6c28
PB
1125 if (sockpath) {
1126 unlink(sockpath);
1127 }
7a5ca864 1128
fbf28a43 1129 qemu_opts_del(sn_opts);
8c116b0e 1130
a517e88b
PB
1131 if (device) {
1132 void *ret;
1133 pthread_join(client_thread, &ret);
1134 exit(ret != NULL);
1135 } else {
1136 exit(EXIT_SUCCESS);
1137 }
7a5ca864 1138}